Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check, take action or notify and auto-update Entrance criteria for releases #5332

Open
gaiksaya opened this issue Feb 20, 2025 · 2 comments
Open
Assignees
Labels
enhancement New Enhancement release

Comments

@gaiksaya
Copy link
Member

gaiksaya commented Feb 20, 2025

Is your feature request related to a problem? Please describe

Coming from #5171

Just focusing on entrance criteria for the scope of this issue

Currently, the release manager must manually verify the entrance criteria before or during the release window. This process is prone to human error and allows for inconsistent execution of releases, as there is no standardized approach. To streamline the process and eliminate these challenges, it would be ideal for these criteria to be automatically checked, updated, and made actionable.

Describe the solution you'd like

The current entrance criterias as as below:

* Each component release issue has an assigned owner

Check:
Check if all the release component issues have release owners assigned using data in the metrics cluster.

Action:
If not, below are the AI:

  • 1 week before the release window opens: Notify by tagging all the maintainers of the repo in the GH comment on the release issue.
  • 3 days before the release window opens: If still no release owner is assigned, we will be randomly assigning one from the list of maintainer.

* Documentation draft PRs are up and in tech review for all component changes.

Check:
Check if the PRs are up for all raised issues. Sample query:

is:issue is:open label:v<release_version> -linked:pr 

Action:

  • If not, a GH issue comment will be added in the raised issues notifying the requester to either create the PR or revert the feature from the release due to lacking documentation.

* Sanity testing is done for all components.

Check:
No direct way of checking it. We reply on component teams to do the needful. From distribution side, we can run smoke tests and validation for sanity.

* Code coverage has not decreased (all new code has tests).

Check:
We are indexing the code coverage data in the metrics cluster. For given release (eg: 2.19) we can check the difference against the last minor (2.18 in this case).

Action:
Notify the teams by commenting on the GH issue as well as main release issue asking to add tests for missing ones as the code coverage as decreased.
Heads-up: Looks like code coverage reporting is a problem for many components. We can use this opportunity to fix that as well.

* Release notes are ready and available for all components.

Check:
Check using metrics data.

Action:
Tag and notify by commenting on component Release issue asking to fulfill the missing criteria.

* Roadmap is up-to-date (information is available to create release highlights).

We rely on component owners and maintainers to update the roadmap. Wondering if making sure the issues are closed as part of the check makes sense @Pallavi-AWS @getsaurabh02

* Release ticket is cut, and there's a forum post announcing the start of the window.

Check:
Check using metrics data and compare against the release input manifest to match the number of components and issues.

Action:
If some are missing, build/infra repo will create the component release issue accordingly.

* Any necessary security reviews are complete.

We rely on component owners and maintainers to follow through.

@gaiksaya gaiksaya added enhancement New Enhancement untriaged Issues that have not yet been triaged labels Feb 20, 2025
@gaiksaya
Copy link
Member Author

Tagging @opensearch-project/engineering-effectiveness to get some inputs or feedback if they have any.
Thanks!

@gaiksaya gaiksaya self-assigned this Feb 20, 2025
@gaiksaya gaiksaya removed the untriaged Issues that have not yet been triaged label Feb 20, 2025
@gaiksaya gaiksaya moved this from 🆕 New to 🏗 In progress in Engineering Effectiveness Board Feb 20, 2025
@peterzhuamazon
Copy link
Member

As of current, roadmap can be auto-updated with a roadmap: or meta / rfc label, tho we do want to make some adjustment so that everyone who open a meta issue get automatically added to the roadmap, and more.

Each meta should also have corresponding label for version so that they can automatically categorized on roadmap.

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New Enhancement release
Projects
Status: 🏗 In progress
Development

No branches or pull requests

2 participants