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

OpenSearch Release Process #3635

Merged
merged 8 commits into from
Aug 7, 2023

Conversation

prudhvigodithi
Copy link
Collaborator

@prudhvigodithi prudhvigodithi commented Jun 15, 2023

Description

Add a detailed document regarding the OpenSearch Release Process.

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@codecov
Copy link

codecov bot commented Jun 15, 2023

Codecov Report

Merging #3635 (5499f36) into main (885e029) will increase coverage by 0.25%.
Report is 17 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3635      +/-   ##
==========================================
+ Coverage   91.61%   91.86%   +0.25%     
==========================================
  Files         182      186       +4     
  Lines        5439     5633     +194     
==========================================
+ Hits         4983     5175     +192     
- Misses        456      458       +2     

see 7 files with indirect coverage changes

RELEASE_PROCESS_OPENSEARCH.md Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved


#### Windows Integ Test

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, we need to elaborate the steps to setup an instance, test and record the results.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding @jordarlu, jeff you have the detailed steps, can you add them here I will take them as reference?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure thing, @prudhvigodithi , let me upadte you on that ... thanks!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jordarlu when you get chance can you please share the steps for windows testing?

Copy link
Member

@peterzhuamazon peterzhuamazon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @prudhvigodithi for creating this draft.
Although it is very details I find it overwhelming even as a seasoned release manager.
Wonder if we can simplify the languages and terms a bit. Thanks!

RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
Comment on lines 183 to 327
#### Integ Test RPM:

| Integ Test RPM | x64 | arm64 |
|----------|----------|----------|
| OpenSearch | [x64](https://build.ci.opensearch.org/job/integ-test/4908/console) | [arm64](https://build.ci.opensearch.org/job/integ-test/4907/console) |
| OpenSearch Dashboards | [x64](https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/3532/console) | [arm64](https://build.ci.opensearch.org/job/integ-test-opensearch-dashboards/3533/console) |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can ignore the rpm ones for now as the tar is enough at this stage.
Rpm is similar to tar and deb is having a small bug at the moment.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure Peter, we should still mention, we might get some contributions/fixes from external RM's. WDYT?

RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
Comment on lines 109 to 112
#### Release Manager

The release managers to a specific OpenSearch release will be assigned through volunteer model. The request for release managers will be posted in [OpenSearch public slack workspace](https://opensearch.slack.com/archives/C0561HRK961) (under releases channel) and selected on first come first served (FCFS) model.
Note: The release managers should be maintainers of a repo under OpenSearch GitHub organization.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are release manager and repo owner, which is a bit confusing to people.
Probably the release manager specifically refer to the Primary release manager.
Then component owner might be better than repository owner? Just a thought.

nknize
nknize previously requested changes Jun 19, 2023
Copy link
Contributor

@nknize nknize left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some good stuff here but I think we need to simplify. I've left some inline comments for things that are confusing to me (let alone a first time RM).

Can we simplify this to an ordered enumerated list of steps to follow? e.g., 1. Release Manager, 2. Feature Freeze, 3. Build RC, 4. Test RC.

Keep it simple, simple, simple. Where the tooling is complex, simplify the documentation. Lets strive for a n00b RM to never have to ask for infra or devops help. Lets keep the fleet of participants as lean as possible.

README.md Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Show resolved Hide resolved
RELEASE_PROCESS_OPENSEARCH.md Outdated Show resolved Hide resolved
@prudhvigodithi
Copy link
Collaborator Author

Thanks for the feedback @nknize.

@prudhvigodithi
Copy link
Collaborator Author

Thanks @dblock updated with your suggestions in latest commit.

@bbarani
Copy link
Member

bbarani commented Jul 31, 2023

Tagging @CEHENKLE and @nknize for review.

@prudhvigodithi
Copy link
Collaborator Author

Sample created release issue with the latest template:
prudhvigodithi/sample-opensearch-ml-models#1

Signed-off-by: Prudhvi Godithi <[email protected]>
@prudhvigodithi
Copy link
Collaborator Author

Thanks everyone for the review and feedback, I will proceed to merge this PR as it is already useful with the release information for an external manager. We can keep improving this document as we move forward with the release retro meetings (Example: https://github.com/orgs/opensearch-project/projects/140/views/1).

@prudhvigodithi prudhvigodithi enabled auto-merge (squash) August 7, 2023 20:37
@prudhvigodithi prudhvigodithi dismissed nknize’s stale review August 7, 2023 20:39

Hey Nick, I will be moving forward with this PR, please check my latest comment #3635 (comment). Thanks

@prudhvigodithi prudhvigodithi merged commit 0777796 into opensearch-project:main Aug 7, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
distinguished-contributor documentation Improvements or additions to documentation release
Projects
Development

Successfully merging this pull request may close these issues.

8 participants