Skip to content

[WIP] Add towncrier to manage CHANGELOG.md #56984

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

Merged
merged 2 commits into from
May 7, 2020
Merged

Conversation

Ch3LL
Copy link
Contributor

@Ch3LL Ch3LL commented Apr 29, 2020

What does this PR do?

Add towncrier to help manage CHANGELOG.md

What issues does this PR fix or reference?

Fixes: #55836

Previous Behavior

Merge conflicts would occur anytime someone edits the changelog

New Behavior

no more merge conflicts and at release time we just need to run towncrier --version=3001 for example.

This PR require a contributor to create a new file under the changelog dir in the salt repo. The filename will need to be <issue number>.<type>. All given types are added, changed, deprecated, fixed, removed. Come release time we will run towncrier and this will combine all the files into the changelog and remove them.

Here is towncrier run with ---draft with these changes:

(salt)  ch3ll@thecakeisalie  ~/git/salt   towncrier  towncrier --draft --version=3001
Loading template...
Finding news fragments...
Rendering news fragments...
Draft only -- nothing has been written.
What is seen below is what would be written.

Salt 3001 (2020-04-14)
======================


Removed
-------

- test remove (#1234)


Deprecated
----------

- test deprecated (#1234)


Changed
-------

- test changed (#1234)


Fixed
-----

- test fixed (#1234)


Added
-----

- test added (#1234)

For the Sodium release we will have to do a combination of things. We will have to manually add the PRs we missed before this is added, and run this before the release for hte PRs that do use this.

@Ch3LL Ch3LL requested a review from a team as a code owner April 29, 2020 16:38
@ghost ghost requested review from dwoz and removed request for a team April 29, 2020 16:38
@dwoz dwoz merged commit df480e3 into saltstack:master May 7, 2020
@sagetherage sagetherage added the ZRelease-Sodium retired label label May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ZRelease-Sodium retired label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

research change log use of tools
3 participants