Add changelog generator based on PR data#7461
Merged
Conversation
ec7282a to
5767582
Compare
oriolgual
previously requested changes
Feb 25, 2021
mrcasals
commented
Feb 25, 2021
Co-authored-by: Oriol Gual <oriolgual@users.noreply.github.com>
Also add a little progress bar
134adf1 to
d52edac
Compare
oriolgual
approved these changes
Feb 25, 2021
This was referenced Mar 1, 2021
entantoencuanto
added a commit
that referenced
this pull request
Mar 2, 2021
* develop: (25 commits) Add css selectors to emails to improve design customization (#7493) Only share tokens if component exists (#7499) Fix record encryptor hash values JSON parsing for legacy unencrypted hash values (#7494) Fix NULL error with weight field in assemblies & processes (#7486) Fix proposals to budget import (#7449) Fix cost display on proposals (#7450) Fix #7487 - Invalid signature on message decryption (#7488) New Crowdin updates (#7482) Move specs file to correct folder (#7476) Improve changelog generator (#7475) New Crowdin updates (#7472) Prepare 0.25-dev version (#7473) New Crowdin updates (#7470) New Crowdin updates (#7468) Feature proposal infinite edit time (#7406) New Crowdin updates (#7457) Trigger docs build on folder changes (#7360) Add changelog generator based on PR data (#7461) Add Votings to Open Data export (#7388) Add order in not highlighted assemblies by weight (#7444) ...
12 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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? Why?
This PR improves how to generate the changelog.
The current (undocumented) process to generate the changelog is this one, using
git notes:git fetch origin refs/notes/*:refs/notes/*to download the latest notes in the commitsgit notes add <SHA>Added: **decidim-core**, **decidim-admin**git push origin refs/notes/*The process implies manual work for every merged PR. If you forget about performing the steps for a PR, the PR won't appear in the changelog.
Since we squash PRs before merging, and the squashed commit contains the reference of the PR it squashes, we can use that to get to the PR and gather data from it. This PR does just that:
If a PR can't be classified, or it doesn't have a way to link it to a PR, then the commit title appears under an
Unsortedsection. This can be used to list all the PRs that haven't yet been classified, so you can classify them easily by changing the labels of the PR.This means we can improve the Changelog shape by modifying the PR title and labels.
Part of the changelog will still need to be changed manually:
This is what the code generates for the current
developbranch (head e417144):Notes:
bin/changelog_generator --help, which shows the usagetemporary_changelog.mdfile, on purpose. This helps keep the output safe (since calculating the changelog is time-consuming action) and lets us show a progress bar to the terminal output.📌 Related Issues
None
Testing
Nothing.