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

Add changie to auto generate CHANGELOG #4696

Closed
wants to merge 22 commits into from
Closed

Add changie to auto generate CHANGELOG #4696

wants to merge 22 commits into from

Conversation

emmyoop
Copy link
Member

@emmyoop emmyoop commented Feb 8, 2022

resolves #4652

Description

This is the branch we would be releasing from. The CHANGELOG has already been generated.

You can see the temporary files generated that make up the changelog in the branches (or in previous commits)
1.0.3

The basic order this works is:

  1. branch as normal, make your changes.
  2. Run changie new and follow command prompt to generate the yaml file with your changelog entry. Commit it.
  3. Create a PR / merge it in
  4. If it needs to be backported, backport it to .latest
  5. Rinse and repeat with other tasks
  6. When ready to release do the following on the .latest branch:
    1. run changie batch <version>. This will delete all the individual yaml changelog files and batch them into a single .md file. You can review and edit this as desired.
    2. Run python add-contributors.py 1.0.3 to add a Contributors section at the end.
    3. Run changie merge to merge the .md you generated with the batch command into the CHANGELOG. The .md is not deleted and persists forever.
    4. release!

Note: This does not include a PR but can easily be added as an input.

@cla-bot cla-bot bot added the cla:yes label Feb 8, 2022
@emmyoop emmyoop changed the title Er/changie main Add changie to auto generate CHANGELOG Feb 9, 2022
@emmyoop emmyoop closed this Feb 14, 2022
@emmyoop emmyoop deleted the er/changie-main branch February 14, 2022 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[CT-115] Automate Changelog
1 participant