[DEV] Automate CHANGELOG.md creation using git-chglog #45
Conversation
This file contains 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
treee111
force-pushed
the
git-changelog
branch
from
7d21e6a to
a0e5545
Compare
treee111
force-pushed
the
git-changelog
branch
2 times, most recently
from
256eb7a to
9631fcf
Compare
treee111
changed the title
treee111
force-pushed
the
git-changelog
branch
from
9631fcf to
793575d
Compare
treee111
force-pushed
the
git-changelog
branch
4 times, most recently
from
f4c589c to
5b63a48
Compare
- ignore tags v0.1.0 - v0.9.0 (manually created CHANGELOG) - insert these manual created CHANGELOG entries in template - created CHANGELOG.md with command "git-chglog -o CHANGELOG.md"
- git-release.yml for "final" versions e.g. v0.10.0 - git-release-pre.yml -pre* version tags e.g. v0.10.0-pre1
treee111
force-pushed
the
git-changelog
branch
from
5b63a48 to
b2a798e
Compare
- new: DEV / Development/Infrastructure/Test/CI - removed: PERF / Performance Improvements
treee111
force-pushed
the
git-changelog
branch
from
d070c25 to
4eb7759
Compare
treee111
changed the title
This was referenced Oct 21, 2021
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.
This PR…
closes #36
Todo
Considerations and implementations
For a commit to appear in the CHANGELOG.md, it has to follow a certain naming pattern:
[type] ...(#PR-number)possible types:
example:
[FEATURE] Add check for required input parameter for CLI and GUI (#41)After installing git-chglog locally, the CHANGELOG.md can be generated with this command:
git-chglog -o CHANGELOG.mdTo generate the CHANGELOG for a upcoming release (no tag exists yet), the following command can be used:
git-chglog -o CHANGELOG.md --next-tag v0.10.0The already existing CHANGELOG entries were copied to the template so that they get included in the generated CHANGELOG.md even if the commits are not following the naming pattern.
How to test
see upper chapter
Optional
Unit-Test(s) added
Having this section helps reminds developers to always add tests, or explain themselves if they can’t!
Screenshots
Having this section makes visual changes immediately obvious, and means visual bugs can often be identified instantly. Also, the screenshots are useful for non-devs preparing content for sprint review, or signing off work.
It’s worth mentioning that in less visual projects, this section could be called “Changes” and contain logs / process flows / etc. This section sometimes contains screenshots of Charles network requests or LogCat messages as well as normal screenshots.