Add Changelog.md and Danger Github action to code review process - #3258
Merged
Conversation
benjaminfaure
approved these changes
Dec 8, 2022
benjaminfaure
left a comment
Contributor
There was a problem hiding this comment.
Looking good, thank you.
Because it includes the CHANGELOG file, should we merge this one as soon as possible ?
briri
reviewed
Dec 8, 2022
briri
approved these changes
Dec 8, 2022
briri
left a comment
Contributor
There was a problem hiding this comment.
looks good Wendy. I'm just wondering if the test check should use the RSpec directory instead of /test/
Contributor
|
and agree with @benjaminfaure that once this is ready we should merge it so we can start using the Changelog immediately |
Contributor
Author
|
Thank you @benjaminfaure @briri ! Will merge after all tests passed |
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.
Fixes #3257
1. Add Danger gem and Github action to the roadmap
Note that Danger is for reference. We can discuss changing the Danger configuration. Currently, the suggestion/reminder is:
[WIP]in the title will make this PR to be a draft pr#trivialmeans no changelog is neededAn example:

2. CHANGELOG.md is ready for use
The workflow would be to add the description and link to the issue (if any) to the CHANGELOG every time a PR is submitted. I created the 'Changed', 'Added' and 'Fixed' sections for categorization purposes, but we are feeling to change to other formats.
The person who's gonna do the release will add the release version as the header to the CHANGELOG. Later, developers will pull the CHANGELOG and continue to build above it.
Example:

By doing this, we will have a good record of the process, and whoever doing the release can use CHANGELOG as part of the release note.
We can also consider adding this step to the contribution guide.