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 to avoid conflicts in HISTORY.rst #1142

Merged
merged 1 commit into from
Jul 4, 2024

Conversation

getzze
Copy link
Collaborator

@getzze getzze commented Jul 3, 2024

See #1138

Documentation here. It is used by many many projects (attrs, pytest, numpy, ...) so it seems a good choice.

Like that, with each commit or PR, we add a news fragment (a file) in the changelog.d folder.
Before making a new release, we call towncrier -- version 2.3.0 and the files are parsed and added nicely to the HISTORY.rst file. They are also deleted from the changelog.d folder.
You can add a news fragment from the command line with: towncrier create --content 'use towncrier' 1138.misc.rst

We have to decide the type of fragments to add. I put:

  • breaking
  • change
  • provider
  • refiner
  • deprecation
  • doc
  • misc

With doc and misc showing only the list of PR numbers in the changelog, not the text.

Notice that it will change the formatting of the HISTORY.rst file, now the title for a new release with the date will be on the same line.

I will add the information about how to make a new release in another PR (first handle the conflicts in HISTORY.rst).

@getzze getzze requested a review from ptrcnull July 3, 2024 22:29
@Diaoul
Copy link
Owner

Diaoul commented Jul 4, 2024

Cool tool, did not know this one. Out of curiosity, what are alternatives? Why this one and not another?

Copy link
Collaborator

@ptrcnull ptrcnull left a comment

Choose a reason for hiding this comment

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

ooh, I like that! especially since the changelogs are still human-written in the end :P

@getzze
Copy link
Collaborator Author

getzze commented Jul 4, 2024 via email

Copy link

github-actions bot commented Jul 4, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

@getzze getzze merged commit d9a8af0 into Diaoul:main Jul 4, 2024
20 checks passed
@getzze getzze deleted the add-towncrier branch July 6, 2024 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants