ci: add commit lint and semantic-release process

See added CONTRIBUTING.md for details.

The purpose is to have 1-click release process done via GitHub actions.

This is achieved via semantic-release which does the whole release
process. Version bump is derived from commit messages using semantic
versioning. That requires commit messages to follow a specific structure
and thus commit lint is added to ensure that all commits follow the
structure.

Signed-off-by: Petr Vobornik <[email protected]>

.github/workflows/commitlint.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: Print versions
+        run: |
+          git --version
+          node --version
+          npm --version
+          npx commitlint --version
+      - name: Install commitlint
+        run: |
+          npm install @commitlint/config-angular@latest
+          npm install commitlint@latest
+      - name: Validate current commit (last commit) with commitlint
+        if: github.event_name == 'push'
+        run: npx commitlint --from HEAD~1 --to HEAD --verbose
+
+      - name: Validate PR commits with commitlint
+        if: github.event_name == 'pull_request'
+        run: npx commitlint --from ${{ github.event.pull_request.head.sha }}~${{ github.event.pull_request.commits }} --to ${{ github.event.pull_request.head.sha }} --verbose

.github/workflows/release.yml

@@ -0,0 +1,40 @@
+# Release process that runs on on manual request (workflow_dispatch)
+
+# How it works:
+# 1. Prepares env to be able to run semantic-release
+# 2. Runs semantic-release which does the whole release process
+
+# See CONTRIBUTING.md for more information how the semantic-release works
+
+---
+name: Release
+on: workflow_dispatch
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: npx semantic-release

.gitignore

@@ -16,3 +16,4 @@ coverage.*
 # Binary
 host-metering
 dist/host-metering
+node_modules

.releaserc

@@ -0,0 +1,44 @@
+{
+    "branches": [
+        "main",
+        "release"
+    ],
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        [
+            "@semantic-release/exec",
+            {
+                "prepareCmd": "make version-update NEXT_VERSION=${nextRelease.version} ;",
+                "publishCmd": "make tarball"
+            }
+        ],
+        [
+            "@semantic-release/changelog",
+            {
+                "changelogFile": "CHANGELOG.md"
+            }
+        ],
+        [
+            "@semantic-release/git",
+            {
+                "assets": [
+                    "version/version.go",
+                    "CHANGELOG.md"
+                ],
+                "message": "build(release): ${nextRelease.version}\n\n${nextRelease.notes}"
+            }
+        ],
+        [
+            "@semantic-release/github",
+            {
+                "assets": [
+                    {
+                        "path": "dist/*.tar.gz",
+                        "label": "Tarball"
+                    }
+                ]
+            }
+        ]
+    ]
+}

CONTRIBUTING.md

@@ -0,0 +1,100 @@
+# Contributing
+
+Open a pull request to contribute a change.
+
+## Commit message format
+
+The project is using [semantic-release](https://semantic-release.gitbook.io/semantic-release/)
+and commit lint which enforces formatting rules on commit messages.
+
+This is a modified version from [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format)
+project.
+
+Each commit message consists of a **header**, a **body**, and a **footer**.
+
+
+```
+<header>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The `header` is mandatory and must conform to the [Commit Message Header](#commit-header) format.
+
+The `body` is mandatory for all commits except for those of type "docs".
+When the body is present it must be at least 20 characters long and must conform to the [Commit Message Body](#commit-body) format.
+
+The `footer` is optional. The [Commit Message Footer](#commit-footer) format describes what the footer is used for and the structure it must have.
+
+
+### <a name="commit-header"></a>Commit Message Header
+
+```
+<type>(<scope>): <short summary>
+  │       │             │
+  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
+  │       │
+  │       └─⫸ Commit Scope: config|selinux|rpm|daemon|hostinfo|notify|packaging|changelog|
+  |                          makefile
+  │
+  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test
+```
+
+The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.
+
+
+#### Type
+
+Must be one of the following:
+
+* **build**: Changes that affect the build system or external dependencies (example scopes: makefile)
+* **ci**: Changes to our CI configuration files and scripts (examples: GitHub Actions)
+* **docs**: Documentation only changes
+* **feat**: A new feature
+* **fix**: A bug fix
+* **perf**: A code change that improves performance
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **test**: Adding missing tests or correcting existing tests
+
+#### Check commit message locally:
+
+```
+$ npm install
+$ npx commitlint --from HEAD~1
+```
+
+## Release
+
+Is using semantic release with semantic versioning.
+
+Semantic-release is configured in `package.json`.
+
+It:
+- determines the current version based on git tags
+- determines the next version based on commit messages
+- bumps version in version/version.go
+- generates CHANGELOG.md update
+- commits the changes
+- creates a git tag
+- pushes the changes to the repo
+- makes a tarball with vendor dependencies included
+- creates a GitHub release with the tarball attached
+
+### Start a release
+
+1. Go to Actions tab on GitHub
+2. Run "Release" workflow.
+
+### Testing release locally
+
+This is bit tricky as the release process pushes to repo. It might be easier
+to do the changes, pushed them to your for on GitHub and execute the release there.
+
+In local machine testing, make sure that the git repo has only your fork as remote
+to avoid accidental release in primary repo.
+
+1. install npm
+2. `$ npm clean-install`
+3. `$ npx semantic-release`

Makefile

@@ -3,6 +3,7 @@
 PROJECT := host-metering
 RPMNAME := host-metering
 VERSION := $(shell grep "Version" version/version.go | awk -F '"' '{print $$2}')
+NEXT_VERSION ?=
 SHORT_COMMIT ?= $(shell git rev-parse --short=8 HEAD)
 AUTORELEASE ?= "git$(shell date "+%Y%m%d%H%M")G$(SHORT_COMMIT)"
 
@@ -103,6 +104,12 @@ clean-pod:
 version:
 	@echo $(VERSION)
 
+.PHONY: version-update
+version-update:
+	@test -n "$(NEXT_VERSION)" || (echo "NEXT_VERSION is not set"; exit 1)
+	@echo "Updating the version to $(NEXT_VERSION)..."
+	sed -i "s/Version = \".*\"/Version = \"$(NEXT_VERSION)\"/" version/version.go
+
 .PHONY: distdir
 distdir:
 	@echo "Creating the destination directory..."