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 towncrier for managing changelog #7

Merged
merged 10 commits into from Dec 26, 2022
Merged

Add towncrier for managing changelog #7

merged 10 commits into from Dec 26, 2022

Conversation

ItsDrike
Copy link
Member

This PR adds towncrier as a tool for managing changelog of the project.

This means a few changes to the project for contributors:

  • All PRs will now have to include a changelog fragment, stating what they've changed, enforced by a new fragment-check workflow
    • Although if it's a small enough chage, the PRs author can request for this fragment check to be skipped (using a label added by a maintainer)
  • Once a new release is expected to be made, the maintainers are expected to manually trigger the new prepare-release workflow, which will automatically create the changelog from individual fragments, and remove the fragments. Only after that should a new release be made (using the standard method - pushing a release tag to main branch)

For more info, a readme file was added: changes/README.md, explaining how this process works, along with a link to the towncrier documentation. This file was then also mentioned as required reading in CONTRIBUTING.md.

@ItsDrike ItsDrike added p: 2 - normal Normal priority t: feature New request or feature a: CI Related to continuous integration and deployment labels Dec 26, 2022
@ItsDrike ItsDrike merged commit cdcde0f into main Dec 26, 2022
@ItsDrike ItsDrike deleted the add-towncrier branch December 26, 2022 22:26
@ItsDrike ItsDrike mentioned this pull request Dec 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a: CI Related to continuous integration and deployment p: 2 - normal Normal priority t: feature New request or feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant