[WIP] Add towncrier to manage CHANGELOG.md #56984
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: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.