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

Cosmetic changelog/changie fixups #4944

Merged
merged 6 commits into from
Mar 24, 2022
Merged

Conversation

jtcohen6
Copy link
Contributor

@jtcohen6 jtcohen6 commented Mar 23, 2022

resolves #4943

  • Reorder change types, both how they'll be ordered in the generated changelog (main concern), and how they'll be presented to contributors for interactive selection
  • Reorder v1.1 release notes + changelog accordingly
  • Add language to v1.1.0b1 "breaking change" to clarify exactly who this might be breaking for (sorta adapter plugin maintainers, really nobody)
  • Contributors:### Contributors (feels right)

After merging: Update v1.1.0b1 release notes

@jtcohen6 jtcohen6 added the Skip Changelog Skips GHA to check for changelog file label Mar 23, 2022
@jtcohen6 jtcohen6 requested a review from emmyoop March 23, 2022 19:21
@jtcohen6 jtcohen6 requested a review from a team as a code owner March 23, 2022 19:21
@cla-bot cla-bot bot added the cla:yes label Mar 23, 2022
@@ -28,7 +28,7 @@ custom:
type: int
minLength: 4
footerFormat: |
Contributors:
### Contributors
Copy link
Contributor Author

@jtcohen6 jtcohen6 Mar 23, 2022

Choose a reason for hiding this comment

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

This one is a no-look pass, I could be wildly off the mark

Copy link
Member

Choose a reason for hiding this comment

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

It's easy to test all your changes work as expected!

Run this to print out what the generated yaml file will be:

changie batch 1.1.0 --dry-run --include '1.1.0'

--dry-run just prints out what would be generated and doesn't actually create a file or delete any yaml and --include will include the yaml files in that directory.

Note: Two new changes have been merged in since the release (2 files exists in .changes/unreleased) so those will be erroneously included. Since it's not creating the files it doesn't matter. This command should be enough to eyeball that the file is generated like you expect.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

realized I needed to update my installed version of changie! after that, works like a charm

Copy link
Member

@emmyoop emmyoop left a comment

Choose a reason for hiding this comment

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

LGTM

@jtcohen6 jtcohen6 merged commit 69cdc41 into main Mar 24, 2022
@jtcohen6 jtcohen6 deleted the fixup-changie-order-1.1-changelog branch March 24, 2022 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes Skip Changelog Skips GHA to check for changelog file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CT-415] Reorder changie change kinds
2 participants