search

opensearch-project / OpenSearch-Dashboards

📊 Open source visualization dashboards for OpenSearch.
https://opensearch.org/docs/latest/dashboards/index/
Apache License 2.0
1.7k stars 901 forks source link

[BUG] Delayed version bumps after a release and automation request #7162

Open gaiksaya opened 5 months ago

gaiksaya commented 5 months ago

Describe the bug

As soon as we release OpenSearch and OpenSearch-Dashboards, one of the post release activity is to bump the version in the development branches to next iteration. See https://github.com/opensearch-project/OpenSearch-Dashboards/issues/6718 However, it has been observed that many times the version is not bumped for a long amount of time. Example: https://github.com/opensearch-project/OpenSearch-Dashboards/blob/1.3/package.json#L14 is still pointing to 1.3.17 which was released on June 06th, 2024.

The distribution workflow in opensearch-build repository uses manifests as source of build. We have an automation in place, that will add those manifests when it detects that the core engine has bumped the version in tracking branches. However, since the versions are not bumped sooner, this delays the below actions:

  1. Creating input manifest
  2. Auto version increment PRs for dependent components
  3. Building next iteration of OpenSearch-Dashboards distribution and help detecting failing component builds
  4. Running integration tests (part of build workflow) that would catch the issues sooner

To Reproduce Steps to reproduce the behavior: See the version bump PR timelines in merged PRs

Expected behavior Bump the version as soon as a tag is cut in this repo. This can be automated similar to OpenSearch https://github.com/opensearch-project/OpenSearch/blob/main/.github/workflows/version.yml

This would be a notable improvement to expedite the release process and avoid last minute chaos.

joshuali925 commented 5 months ago

this doesn't seem to be a bug. what is the recommended action to improve?

i don't know about this repo, but in many other places i see version bump PR CI failed due to dependency version not upgraded

gaiksaya commented 5 months ago

this doesn't seem to be a bug. what is the recommended action to improve?

i don't know about this repo, but in many other places i see version bump PR CI failed due to dependency version not upgraded

I added it as a bug since manual version bumps are not being done is timely manner. One of the recommended approach would be to parse the package.json and bump the version when a tag is cut in this repo. See OpenSearch workflow posted above.

@AMoo-Miki @kavilla do you guys have a better approach?

AMoo-Miki commented 4 months ago

I believe we are relying on the human factor to make sure snapshots and possibly other artifacts catch up or else we will have a period where everything fails, blocking us from merging anything.

Why not just raise a PR as opposed to bumping? When PR tests pass, it indicates that the artifacts are in place and the PR can be merged.

AMoo-Miki commented 1 month ago

@gaiksaya any thoughts?

gaiksaya commented 1 month ago

Hi @AMoo-Miki ,

Yeah that is the ask. Add an automation such that when a tag is cut version bump PR is created. Keep running CI's until they pass and once done merge it. I have posted a similar example in the issue description on how OpenSearch does it today.