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

Use towncrier for changelog generation #5634

Merged
merged 2 commits into from
Jul 26, 2023
Merged

Conversation

MetRonnie
Copy link
Member

@MetRonnie MetRonnie commented Jul 20, 2023

https://towncrier.readthedocs.io/en/stable/index.html

If we go for this it means no more changelog conflicts 🎉 Instead you either

  • write your changelog entries to a file at changes.d/<PR-number>.<break|feat|fix>.md
  • or run towncrier create <PR-number>.<break|feat|fix>.md --content "<insert content here>"

and before the release they get collated into CHANGES.md.

Also it guarantees changelog entries go under the right release section despite any milestone bump-backs or cherry-picks that happen.

Closes #4356

Check List

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Dependency changes do not apply to conda-environment.yml
  • Tests N/A
  • No changelog entry needed
  • No cylc-doc change needed

@MetRonnie MetRonnie added the infrastructure GH Actions, Codecov etc. label Jul 20, 2023
@MetRonnie MetRonnie added this to the cylc-8.2.1 milestone Jul 20, 2023
@MetRonnie MetRonnie self-assigned this Jul 20, 2023
@MetRonnie
Copy link
Member Author

MetRonnie commented Jul 20, 2023

Here is the towncrier build generated changelog section from a bunch of example fragment files I added. (Normally the fragment files get deleted when you run towncrier build [--yes])

image

@MetRonnie
Copy link
Member Author

MetRonnie commented Jul 21, 2023

In response to a question Dave asked: although these changelog fragments will be included into the master branch in sync PRs, once we do a maintenance release and subsequent sync PR, the deleted fragments will also be removed on master so you won't get duplicate entries under maintenance and minor sections in CHANGES.md

Copy link
Member

@oliver-sanders oliver-sanders left a comment

Choose a reason for hiding this comment

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

Willing to give it a go.

.github/workflows/1_create_release_pr.yml Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

Nice 👍

@hjoliver hjoliver merged commit ae24bef into cylc:8.2.x Jul 26, 2023
29 of 37 checks passed
@MetRonnie MetRonnie deleted the towncrier branch July 26, 2023 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure GH Actions, Codecov etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants