Merge pull request #19 from postfinance/feature/semantic-release

ci: introduce semantic-release

.commitlintrc.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ]
+}

.github/dependabot.yml

@@ -12,3 +12,9 @@ updates:
       interval: 'weekly'
     assignees:
       - 'bbortt'
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'weekly'
+    assignees:
+      - 'bbortt'

.github/workflows/build.yaml

@@ -5,7 +5,7 @@ on:
       - '**/*'
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/publish.yaml → .github/workflows/docker.yaml

@@ -1,13 +1,12 @@
-name: publish
+name: docker
 on:
+  pull_request:
   push:
     branches:
-      - release
     tags:
-      - 'v*'
 jobs:
-  release:
-    runs-on: ubuntu-latest
+  publish:
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v3

.github/workflows/lint.yaml

@@ -0,0 +1,21 @@
+name: lint
+on:
+  pull_request:
+jobs:
+  commitlint:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          cache: 'npm'
+          node-version: 16
+      - name: Fetch Release Information
+        run: git fetch origin release
+      - name: Install Dependencies
+        run: npm ci
+      - name: Lint Commit Messages
+        run: |
+          npx --no-install commitlint --from origin/release --to HEAD --verbose

.github/workflows/release.yaml

@@ -0,0 +1,25 @@
+name: release
+on:
+  push:
+    branches:
+      - release
+jobs:
+  release:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          cache: 'npm'
+          node-version: 16
+      - name: Install Dependencies
+        run: npm ci
+      - name: Create next release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          npx semantic-release

.gitignore

@@ -1,3 +1,4 @@
 *.iml
-
 .idea/
+
+node_modules/

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit 

.releaserc.json

@@ -0,0 +1,24 @@
+{
+  "branches": [
+    "release"
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/github",
+      {
+        "assets": [
+          {
+            "path": "README.md",
+            "label": "CSS distribution"
+          },
+          {
+            "path": "dist/asset.min.js",
+            "label": "JS distribution"
+          }
+        ]
+      }
+    ]
+  ]
+}

DEVELOPMENT.md

@@ -3,10 +3,41 @@
 Contents:
 
 * [Automatic Versioning](#automatic-versioning)
+* [Docker Tagging](#docker-tagging)
 
 ## Automatic Versioning
 
-The automatic versioning happens in the [build action](https://github.com/postfinance/polling-swagger-ui/actions)
+You must follow [the conventional commit messages pattern](https://www.conventionalcommits.org/en/v1.0.0/) when
+contributing to this repository!
+
+> Conventional Commits: A specification for adding human and machine readable meaning to commit messages.
+
+The commit message should be structured as follows:
+
+```shell
+<type>[optional scope]: <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+Consider reading [the summary](https://www.conventionalcommits.org/en/v1.0.0/#summary) if you don't know anything about
+the available types.
+
+### `semantic-release`
+
+The pipeline uses [`semantic-release`](https://github.com/semantic-release/semantic-release/) internally. Take a look at
+the [`release`-workflow](https://github.com/postfinance/polling-swagger-ui/blob/release/.github/workflows/release.yaml)
+or
+[the official documentation](https://github.com/semantic-release/github/) in order to get started.
+
+An access token (`GITHUB_TOKEN`) with the following scope is required for `semantic-release` to work properly: `public_repo`
+.
+
+## Docker Tagging
+
+Docker image tagging happens in the [build action](https://github.com/postfinance/polling-swagger-ui/actions)
 according to SemVer. It uses the [`docker/metadata-action`](https://github.com/docker/metadata-action#semver):
 
 | Event           | Ref                           | Docker Tags                         |