chore: setup semantic-release github action workflow (#15)

Author: natterstefan

.github/workflows/ci.yml

@@ -7,8 +7,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 1
       - uses: actions/setup-node@v2
         with:
           node-version: 14

.github/workflows/cypress.yml

@@ -10,8 +10,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 1
       - uses: actions/setup-node@v2
         with:
           node-version: 14

.github/workflows/release.yml

@@ -0,0 +1,60 @@
+# inspired by
+# @see https://github.com/Jungwoo-An/react-editor-js/blob/1375dea6a3704d16bb234eaa58db6e4104807a11/.github/workflows/publish.yml
+name: release
+
+on:
+  workflow_dispatch:
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+    if: "! contains(github.event.head_commit.message, '[skip ci]')"
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: natterstefan-nextjs-template-${{ hashFiles('**/yarn.lock') }}
+      - run: yarn install
+      - run: chmod -R +x ./node_modules/.bin
+
+  validate:
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set @natterstefan-bot as committer
+        run: |
+          git config user.name "natterstefan Bot"
+          git config user.email "natterstefan-bot@users.noreply.github.com"
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: natterstefan-nextjs-template-${{ hashFiles('**/yarn.lock') }}
+      - run: yarn install
+      - run: yarn lint
+      - run: yarn test
+      - run: yarn test:cypress:ci
+
+  publish:
+    needs: validate
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+      - uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: natterstefan-nextjs-template-${{ hashFiles('**/yarn.lock') }}
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

package.json

@@ -41,6 +41,11 @@
     "@commitlint/cli": "^12.1.1",
     "@commitlint/config-conventional": "^12.1.1",
     "@natterstefan/scripts": "^1.2.0",
+    "@semantic-release/changelog": "^5.0.1",
+    "@semantic-release/commit-analyzer": "^8.0.1",
+    "@semantic-release/git": "^9.0.0",
+    "@semantic-release/github": "^7.2.1",
+    "@semantic-release/release-notes-generator": "^9.0.2",
     "@storybook/addon-actions": "^6.2.9",
     "@storybook/addon-essentials": "^6.2.9",
     "@storybook/addon-links": "^6.2.9",
@@ -81,6 +86,7 @@
     "prettier": "^2.2.1",
     "sass": "^1.32.11",
     "sass-loader": "^11.0.1",
+    "semantic-release": "^17.4.2",
     "start-server-and-test": "^1.12.1",
     "storybook-addon-next-router": "^2.0.4",
     "style-loader": "^2.0.0",

release.config.js

@@ -0,0 +1,37 @@
+/* eslint-disable no-template-curly-in-string */
+/**
+ * Docs
+ * @see https://github.com/semantic-release/semantic-release/blob/1d1b52a7dc02e63c41308f4d196983e0b5081e51/docs/usage/configuration.md
+ * @see https://github.com/semantic-release/semantic-release/blob/1d1b52a7dc02e63c41308f4d196983e0b5081e51/docs/recipes/github-actions.md
+ */
+module.exports = {
+  branches: ['main'],
+  tagFormat: '${version}',
+  plugins: [
+    // verify commits
+    [
+      '@semantic-release/commit-analyzer',
+      {
+        preset: 'conventionalcommits',
+      },
+    ],
+    // generate release notes
+    [
+      '@semantic-release/release-notes-generator',
+      {
+        preset: 'conventionalcommits',
+      },
+    ],
+    // generate CHANGELOG.md
+    [
+      '@semantic-release/changelog',
+      {
+        changelogTitle: '# nextjs-template Changelog',
+      },
+    ],
+    // publish a new release on github
+    '@semantic-release/github',
+    //  commit release assets to the project's git repository.
+    '@semantic-release/git',
+  ],
+}