Skip to content

docs: Add release checklist step to reference the release-specific instructions file #25854

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.

Sign up for GitHub

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

Jump to bottom
Merged
reggie-k merged 22 commits into from
Jan 13, 2026
Merged

docs: Add release checklist step to reference the release-specific instructions file #25854

reggie-k merged 22 commits into from
Jan 13, 2026

Conversation

@revitalbarletz
Copy link
Contributor

@revitalbarletz revitalbarletz commented Jan 5, 2026

Add documentation PR reminder for next minor version after RC.
Fixes #25492

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Title of the PR
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

@revitalbarletz
Update release checklist with documentation PR step
2333d5f 
Add documentation PR reminder for next minor version after RC.

Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz revitalbarletz requested review from a team as code owners January 5, 2026 10:22
@bunnyshell
Copy link

bunnyshell bot commented Jan 5, 2026 •
edited
Loading

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

@revitalbarletz
Copy link
Contributor Author

revitalbarletz commented Jan 5, 2026

@reggie-k can you take a look?

@revitalbarletz revitalbarletz changed the title Update release checklist with documentation PR step docs: Update release checklist with documentation PR step Jan 5, 2026
@revitalbarletz
Update minor_version_update.md
4138c06 
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz
Enhance minor version update template
bb8b305 
Added sections for deprecated items and upgrade instructions.

Signed-off-by: Revital Barletz <[email protected]>
pjiang-dev
pjiang-dev suggested changes Jan 6, 2026
View reviewed changes
reggie-k
reggie-k reviewed Jan 6, 2026
View reviewed changes
Copy link
Member

@reggie-k reggie-k left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!
I think that the ISSUE_TEMPLATE is mainly for creating GitHub issues,so it would be better to put this template file in another place, like a new templates folder under docs or under docs/operator-manual.
I also think it is better to put the healthcheck section at the bottom of the page as it will mostly be the longest part of the doc.

revitalbarletz and others added 5 commits January 7, 2026 13:34
@revitalbarletz @pjiang-dev
Update .github/ISSUE_TEMPLATE/minor_version_update.md
30209d4 
Co-authored-by: Peter Jiang <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz @pjiang-dev
Update .github/ISSUE_TEMPLATE/minor_version_update.md
9f5f4f1 
Co-authored-by: Peter Jiang <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz @pjiang-dev
Update .github/ISSUE_TEMPLATE/minor_version_update.md
5e958ed 
Co-authored-by: Peter Jiang <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz @pjiang-dev
Update .github/ISSUE_TEMPLATE/minor_version_update.md
89433ba 
Co-authored-by: Peter Jiang <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz
Add upgrade guide for minor version changes
f8a9b5a 
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz revitalbarletz requested review from a team as code owners January 7, 2026 11:38
@revitalbarletz
Delete .github/ISSUE_TEMPLATE/minor_version_update.md
db134d3 
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz
Fix documentation PR link in release checklist
4e6e8cc 
Updated the documentation PR template link for the next minor version in the release checklist.

Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz
Copy link
Contributor Author

revitalbarletz commented Jan 7, 2026

Thanks @reggie-k & @pjiang-dev , I have addressed your comments, please review again.

reggie-k
reggie-k reviewed Jan 12, 2026
View reviewed changes
Copy link
Member

@reggie-k reggie-k left a comment

Choose a reason for hiding this comment

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

I left some comments regarding the structure, and we should probably change the PR title to Update release checklist with upgrade instructions template documentation PR step, based on a template

revitalbarletz and others added 2 commits January 12, 2026 12:42
@revitalbarletz @reggie-k
Update docs/operator-manual/templates/minor_version_upgrade.md
311fbf8 
Co-authored-by: Regina Voloshin <[email protected]>
Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz
Revise minor version upgrade documentation
84b5d55 
Reorganized sections for clarity and added details on health checks.

Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz revitalbarletz changed the title docs: Update release checklist with documentation PR step docs: Add release checklist step to reference the release-specific instructions file Jan 12, 2026
@revitalbarletz
Copy link
Contributor Author

revitalbarletz commented Jan 12, 2026

@reggie-k comments addressed. Thank you!

@reggie-k
Copy link
Member

reggie-k commented Jan 12, 2026

@revitalbarletz One last request and we're good to go! Let's make the description under each header an md comment, so that it is visible only to the contributors who fill those sections and not to the end users.

@revitalbarletz
Clean up comments in minor_version_upgrade.md
d1604fc 
Removed comments from the minor version upgrade template.

Signed-off-by: Revital Barletz <[email protected]>
@revitalbarletz
Copy link
Contributor Author

revitalbarletz commented Jan 13, 2026

@reggie-k great idea! Done.

reggie-k
reggie-k reviewed Jan 13, 2026
View reviewed changes
Copy link
Member

@reggie-k reggie-k left a comment

Choose a reason for hiding this comment

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

Thanks! I've realized the step in release.md belongs to the RC1 section as a last step. Could you move it there?

@revitalbarletz
Remove duplicate documentation PR checklist item
e1e7120 
Removed duplicate checklist item for opening documentation PR after creating RC.

Signed-off-by: Revital Barletz <[email protected]>
reggie-k
reggie-k approved these changes Jan 13, 2026
View reviewed changes
Copy link
Member

@reggie-k reggie-k left a comment

Choose a reason for hiding this comment

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

Thanks a lot! LGTM.

@reggie-k reggie-k merged commit fb56875 into argoproj:master Jan 13, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@reggie-k reggie-k reggie-k approved these changes

+1 more reviewer

@pjiang-dev pjiang-dev pjiang-dev approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Adding a template for the Argo CD version upgrade guide

3 participants

@revitalbarletz @reggie-k @pjiang-dev