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

Create ReleaseOwner.md file #1459

Conversation

abhinavGupta16
Copy link
Contributor

Signed-off-by: Abhinav Gupta abhng@amazon.com

Description

This file lists down the duties to be performed by the release manager.

Issues Resolved

#1257

Check List

  • Commits are signed per the DCO using --signoff

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.

Signed-off-by: Abhinav Gupta <abhng@amazon.com>
@codecov-commenter
Copy link

codecov-commenter commented Jan 13, 2022

Codecov Report

Merging #1459 (77e304e) into main (2396ec4) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##               main    #1459   +/-   ##
=========================================
  Coverage     94.35%   94.35%           
  Complexity       12       12           
=========================================
  Files           149      149           
  Lines          3169     3170    +1     
  Branches          9        9           
=========================================
+ Hits           2990     2991    +1     
  Misses          172      172           
  Partials          7        7           
Impacted Files Coverage Δ
tests/jenkins/jobs/uploadSnapshotsToS3_Jenkinsfile
...ts/jenkins/jobs/uploadMinSnapshotsToS3_Jenkinsfile 100.00% <0.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2396ec4...77e304e. Read the comment docs.

@abhinavGupta16
Copy link
Contributor Author

This is a draft PR with initial steps and their descriptions. I will keep adding to this.

Please feel free to commit any changes in document. Inputs are welcome.

@abhinavGupta16 abhinavGupta16 linked an issue Jan 13, 2022 that may be closed by this pull request
6 tasks
@dblock
Copy link
Member

dblock commented Jan 13, 2022

This seems to mostly duplicate the content in https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/release_template.md. I would extend that template as needed and not create a ReleaseOwner.md. There's a <details><summary>How to use this issue</summary> in there and you could do something similar for tasks that require more explanation. WDYT?

Another option is that this content goes into RELEASING.md, but releasing is basically the content in README.

Finally, a third option is RELEASE_OWNERS.md which is similar to OWNERS.md that we have now.

@abhinavGupta16
Copy link
Contributor Author

This seems to mostly duplicate the content in https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/release_template.md. I would extend that template as needed and not create a ReleaseOwner.md. There's a <details><summary>How to use this issue</summary> in there and you could do something similar for tasks that require more explanation. WDYT?

Another option is that this content goes into RELEASING.md, but releasing is basically the content in README.

Finally, a third option is RELEASE_OWNERS.md which is similar to OWNERS.md that we have now.

We could add it as a part of the template, but it would be difficult to copy paste from it to create an issue in future. How would that work?

Completely unrelated, we'll need to update release_template.md as well.

@abhinavGupta16 abhinavGupta16 marked this pull request as ready for review January 28, 2022 02:13
Signed-off-by: Abhinav Gupta <abhng@amazon.com>
Signed-off-by: Abhinav Gupta <abhng@amazon.com>
Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

The majority of this content is duplicate of https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/release_template.md and is bound to get out of date.

What's the reason not to modify that template with the missing content? Maybe a new section under the instructions div?

@abhinavGupta16
Copy link
Contributor Author

The majority of this content is duplicate of https://github.com/opensearch-project/opensearch-build/blob/main/.github/ISSUE_TEMPLATE/release_template.md and is bound to get out of date.

What's the reason not to modify that template with the missing content? Maybe a new section under the instructions div?

Upon further looking into the issue - The instructions are specific to the release owner only who performs these tasks. Adding all the details here explaining each task may make the issue very large with a lot details that maybe irrelevant to all the stakeholders. Alternatively, do you think we can add the this doc and link these instructions to the Issue_template?

@dblock
Copy link
Member

dblock commented Feb 11, 2022

#1612 has replaced most of this, no? @peternied @abhinavGupta16

@peternied
Copy link
Member

#1612 has replaced most of this, no? @peternied @abhinavGupta16

I agree. There are items from #1258 that are in this PR such as the release candidate selection process that I would recommend get spun off into a new PR on the issue template

@bbarani
Copy link
Member

bbarani commented Mar 3, 2022

#1612 has replaced most of this, no? @peternied @abhinavGupta16

I agree. There are items from #1258 that are in this PR such as the release candidate selection process that I would recommend get spun off into a new PR on the issue template

We are looking in to creating a new PR directly on the issue template with the suggested changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the function of the release manager
5 participants