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

PRs with docs changes appear in their own sections in changelog #3437

Merged
merged 10 commits into from Mar 21, 2023

Conversation

haywoodsh
Copy link
Contributor

@haywoodsh haywoodsh commented Jan 13, 2023

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.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@github-actions github-actions bot added the chore Pull requests for routine tasks label Jan 13, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jan 13, 2023

Codecov Report

Merging #3437 (203ae98) into main (b649666) will increase coverage by 0.02%.
The diff coverage is n/a.

@@            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 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 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 haywoodsh force-pushed the chore/rearrange-changelog-labels branch from 1376bc0 to baf6105 Compare January 19, 2023 10:36
@haywoodsh haywoodsh force-pushed the chore/rearrange-changelog-labels branch from baf6105 to bb3ce8f Compare January 19, 2023 10:37
@haywoodsh 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
@haywoodsh haywoodsh marked this pull request as ready for review March 20, 2023 10:16
@haywoodsh haywoodsh requested a review from a team as a code owner March 20, 2023 10:16
Copy link
Member

@ciarams87 ciarams87 left a comment

Choose a reason for hiding this comment

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

Looks good!

@tomasohaodha tomasohaodha added this to the v3.1.0 milestone Mar 20, 2023
@lucacome lucacome merged commit 791a5af into main Mar 21, 2023
58 checks passed
@lucacome lucacome deleted the chore/rearrange-changelog-labels branch March 21, 2023 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

None yet

9 participants