ci: Start using conventional commits

Author: polyfloyd

.cz.toml

@@ -0,0 +1,4 @@
+[tool.commitizen]
+name = "cz_conventional_commits"
+version = "1.0.6"
+tag_format = "v$version"

.github/workflows/bump.yml

@@ -0,0 +1,30 @@
+name: Bump
+
+on:
+  workflow_dispatch:
+
+jobs:
+
+  ci:
+    uses: ./.github/workflows/ci.yml
+
+  bump:
+    runs-on: ubuntu-latest
+
+    needs:
+      - ci
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+        ssh-key: "${{ secrets.DEPLOY_SSH_KEY }}"
+    - run: pip3 install Commitizen==2.27.1
+
+    - run: git config --local user.email "[email protected]"
+    - run: git config --local user.name "github-actions"
+
+    - run: cz bump --changelog
+
+    - run: git push
+    - run: git push --tags

.github/workflows/main.yml renamed to .github/workflows/ci.yml

@@ -7,6 +7,7 @@ on:
   pull_request:
     branches:
       - main
+  workflow_call:
 
 
 jobs:
@@ -25,3 +26,14 @@ jobs:
       run: go build -v
     - name: go test
       run: go test -test.v -race -cover
+
+  conventional-commits:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+    - run: pip3 install -U Commitizen
+      # The commit hash here is that of the commit where we started using conventional commits.
+    - run: cz check --rev-range deebab92..HEAD

README.md

@@ -84,3 +84,15 @@ case *MyError:
 var me MyError
 ok := errors.As(err, &me)
 ```
+
+## Contributing
+
+Do you think you have found a bug? Then please report it via the Github issue tracker. Make sure to
+attach any problematic files that can be used to reproduce the issue. Such files are also used to
+create regression tests that ensure that your bug will never return.
+
+When submitting pull requests, please prefix your commit messages with `fix:` or `feat:` for bug
+fixes and new features respectively. This is the
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) scheme that is used to
+automate some maintenance chores such as generating the changelog and inferring the next version
+number.