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
PRs with docs changes appear in their own sections in changelog #3437
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #3437 +/- ##
==========================================
+ Coverage 52.33% 52.35% +0.02%
==========================================
Files 59 59
Lines 16880 16880
==========================================
+ Hits 8834 8838 +4
+ Misses 7749 7747 -2
+ Partials 297 295 -2 see 1 file with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
haywoodsh
changed the title
Move Documentation down so that PRs with docs changes are in their own section in the auto-generated changelog
Move Documentation down so that PRs with docs changes appear in the correct section in the changelog
Jan 13, 2023
haywoodsh
changed the title
Move Documentation down so that PRs with docs changes appear in the correct section in the changelog
Rearrange labels so that PRs with docs changes appear in the correct section in the changelog
Jan 19, 2023
haywoodsh
force-pushed
the
chore/rearrange-changelog-labels
branch
from
January 19, 2023 10:36
1376bc0
to
baf6105
Compare
haywoodsh
force-pushed
the
chore/rearrange-changelog-labels
branch
from
January 19, 2023 10:37
baf6105
to
bb3ce8f
Compare
haywoodsh
changed the title
Rearrange labels so that PRs with docs changes appear in the correct section in the changelog
PRs with docs changes appear in their own sections in changelog
Feb 20, 2023
ciarams87
reviewed
Mar 20, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
ciarams87
approved these changes
Mar 20, 2023
jjngx
approved these changes
Mar 20, 2023
vepatel
approved these changes
Mar 20, 2023
lucacome
reviewed
Mar 20, 2023
shaun-nx
approved these changes
Mar 21, 2023
lucacome
approved these changes
Mar 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
This PR rearranges the labels for the auto-generated change log so that PRs with docs changes appear in their own sections instead of being grouped under “📝 Documentation”. The current order of labels causes PRs with other labels (such as helm chart, chore, tests) to be placed under “📝 Documentation” if they also have documentation changes. This makes the change log less accurate and informative about the work done in a release. For example, see https://github.com/nginxinc/kubernetes-ingress/releases/tag/v3.0.0.
Checklist
Before creating a PR, run through this checklist and mark each as complete.