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

chore: set up towncrier for changelog management #861

Merged
merged 1 commit into from
Mar 22, 2024
Merged

Conversation

SdgJlbl
Copy link
Contributor

@SdgJlbl SdgJlbl commented Mar 22, 2024

Description

How has this been tested?

Checklist

  • changelog was updated with notable changes
  • documentation was updated

@SdgJlbl SdgJlbl requested a review from a team as a code owner March 22, 2024 15:48
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 22, 2024
Signed-off-by: SdgJlbl <sarah.diot-girard@owkin.com>
@SdgJlbl SdgJlbl force-pushed the chore/add-towncrier branch from f6689aa to 9241ae7 Compare March 22, 2024 15:50
@@ -0,0 +1 @@
- [chore] `towncrier` is now used for changelog management ([#861](https://github.com/Substra/substra-backend/pull/861))
Copy link
Member

Choose a reason for hiding this comment

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

Do we need to specify "chore" in the message ?

Copy link
Member

Choose a reason for hiding this comment

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

(asking for my future self)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no, the only thing that matters is the name of the file (has to end with .added, .fixed, .removed or .changed

you can put whatever you want inside the file, including nested multiline lists, code snippets...

Copy link
Member

Choose a reason for hiding this comment

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

okay I see thx

@SdgJlbl SdgJlbl merged commit 1f61a54 into main Mar 22, 2024
7 checks passed
@SdgJlbl SdgJlbl deleted the chore/add-towncrier branch March 22, 2024 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants