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.
Check list
Description
As discussed in #479, we'd like to use conventional commits for this project going forward. To help with this, this PR
commitlint.git-cliff.I'm using both of these tools in my dayjob, so I'm already familiar with them.
commitlintseems to be the goto solution for linting against conventional commits and from my research seems to be pretty much the only option. The downside of commitlint is that it is only available throughnpm, which means we have to first installnpmand thencommitlintin the workflow - which is a bit slow. I tried using the setup-node action, as outlined in commitlints docs, but this action seems to assume a Node.js based project and complains about the missing package-lock.json.I decided to go with
git-cliff, because I've had a very good experience using it and because I know it to be very flexible. Another big plus IMO, is that it can also be installed locally, which makes testing/troubleshooting a lot easier. I've created a release on my fork, so you can get an impression about how the changelog would look like. Ignore that most changes are currently listed under "Other". This is only the case because those commits do not follow conventional commits yet.Type of change
Test environment