build: Add git-cliff support for changelog generation #1825
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
Check for feat tag Check for build tag Better quotes Check for all our conventional commits Officially recognise build section in changelog Update docs for conventional commits
trisyoungs
approved these changes
Apr 5, 2024
|
See also #1834. |
jws-1
approved these changes
Apr 5, 2024
|
@trisyoungs That is a very valid question. My updated
|
Co-authored-by: Jared Swift <j.w.swift@outlook.com>
Co-authored-by: Jared Swift <j.w.swift@outlook.com>
trisyoungs
reviewed
Apr 8, 2024
Comment on lines
+71
to
+72
| r) BRANCH=$(git rev-parse --abbrev-ref HEAD) | ||
| if [ "$BRANCH" != "Release" ] |
There was a problem hiding this comment.
Is this right? If I run this on a release branch I get, for example, release/1.4.3 which wouldn't satisfy the test...
There was a problem hiding this comment.
I'm specifically creating a branch named Release, since release was already taken. It is only on that branch that the test will pass.
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.
DO NOT MERGE WITHOUT WARNING THE REST OF THE TEAM
This PR adds a check to the CI that will enforce the use of Conventional Commits when submitting a PR. A pull request template is included to remind developers to include an appropriate title for their PR.
As a final change, the
changeversionscript is updated to automatically pull the next version number fromgit cliff --bump. This also means that it is no longer necessary (or possible) to pass the desired version type to the script.