New process for CHANGELOG entries #1749
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.
This introduces a new process for recording CHANGELOG entries, as previously discussed.
tl;dr
Entries have to be written in individual files in
changelog.d
, with omitted PR numbers.Details
On every pull request, one is supposed to create a new file in the appropriate subdirectory of
changelog.d
, containing just the text of the corresponding changelog entry. There is no need to explicitly write a PR number, because themk-changelog.sh
script will add it automatically at the end. The name of the file does not matter, but please try to make it unique to avoid unnecessary conflicts (e.g. use the branch name).It is still possible to write the PR number manually if so desired, which is useful in case the entry should refer to multiple PRs. In that case, the script leaves the PR number reference intact, as long as it is at the very end of the entry (no period allowed afterwards!), and in brackets. It is also possible to use the pattern
##
to refer to the current PR number. This will be replaced throughout.Multiline entries are supported, and should be handled correctly. Again, the PR reference should either be omitted or put at the very end. If multiple entries for a single PR are desired, one should create a different file for each of them.
Generating a CHANGELOG for a release
Just run the script
changelog.d/mk-changelog.sh
with no arguments. It will print all the entries, nicely formatted, on standard output. The script gets PR numbers from thegit
log. If that fails for any reason (e.g. if an entry was added outside of a PR), make sure that the entry has a manually specified PR number.There is a branch https://github.com/wireapp/wire-server/tree/akshaymankar/changelog-d-test with some fake merge commits to test that PR number fetching works properly.
Checklist
changelog.d
.