ci: switch to conventionalcommits (#6245)

.github/workflows/release.yml

@@ -49,8 +49,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GH_TOKEN_RELEASE: ${{ secrets.GH_TOKEN_RELEASE }}
         with:
-          semantic_version: 18
+          semantic_version: 19
           extra_plugins: |
+            conventional-changelog-conventionalcommits@5.0.0
             @semantic-release/changelog@6
             semantic-release-github-pullrequest
 

.github/workflows/semantic.yml

@@ -0,0 +1,14 @@
+name: Lint PR
+
+on:
+  pull_request:
+    types: [opened, edited, synchronize]
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.releaserc

@@ -10,7 +10,7 @@
     [
       "@semantic-release/commit-analyzer",
       {
-        "preset": "angular",
+        "preset": "conventionalcommits",
         "releaseRules": [
           {"scope": "no-release", "release": false}
         ]
@@ -19,10 +19,7 @@
     [
       "@semantic-release/release-notes-generator",
       {
-        "preset": "angular",
-        "parserOpts": {
-          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES", "BREAKING"]
-        },
+        "preset": "conventionalcommits",
         "writerOpts": {
           "commitGroupsSort": ["feat"],
           "commitsSort": ["scope", "subject"]

CONTRIBUTING.md

@@ -51,11 +51,14 @@ everyone is a beginner at first :smile_cat:
 * Write a good commit message. To write good commit messages, please follow
 [those recommendations](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 There are important to maintain an healthy commit logs.
+* We follow [conventionalcommits](https://www.conventionalcommits.org/en/v1.0.0/)
+guideline in our Pull Request title. Please follow it: use the `feat` type
+for new features pull request, and `fix` type to fix a bug.
 * If there are multiple commits in your pull request, these commits will be
 squashed before merging. Please make sure, if that's the case, that your pull
 request has a nice description explaining what it does.
-* It's okay to have work-in-progress pull requests. Add `[WIP]` in the title of
-your pull request if that's the case, otherwise your pull request will be
+* It's okay to have work-in-progress pull requests. Create a `draft` pull request
+if that's the case, otherwise your pull request will be
 considered in a state of being able to be merged as is.
 * If you wish to appear as a contributor, update the CONTRIBUTORS file and
 add your name to it. Include this change in your pull request.

CONTRIBUTORS

@@ -8,6 +8,7 @@ Format: Firstname Lastname @github-handle <email>
 CONTRIBUTORS
 ------------
 Maazarin @djaiss
+Alexis Saettler @asbiin <alexis@saettler.org>
 Kirk Strauser @kstrauser
 Taryn Hill @Phrohdoh <taryn@phrohdoh.com>
 Andreas Zweili @Nebucatnetzer
@@ -25,7 +26,6 @@ Craig Davison @davisonio <craig@davison.io>
 Michael Heap @mheap <m@michaelheap.com>
 Matthew Du Pont @mattdp <monica@matthewfdupont.com>
 Kovah @kovah <contact@kovah.de>
-Alexis Saettler @asbiin <alexis@saettler.org>
 Steven Maguire @stevenmaguire <stevenmaguire@gmail.com>
 @erdmenchen
 Tom Rochette @tomzx <tom@tomrochette.com>