ci: 🎡 switch to @semantic-release/release-notes-generator, test

.

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: '⚗️ Test'
+on:
+  pull_request:
+    branches:
+      - main
+      - master
+      - canary
+jobs:
+  release:
+    name: '⚗️ Test'
+    runs-on: ubuntu-latest
+    steps:
+      - name: '🌵️ Cache-tus'
+        uses: actions/cache@v2
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
+      - name: '📦️ Install Dependecies'
+        run: |
+          yarn install --frozen-lockfile --ignore-engines --network-concurrency 1
+      - name: '🧪️ Lint, Test'
+        run: |
+          yarn lint
+          yarn test

package.json

@@ -36,8 +36,8 @@
   "devDependencies": {
     "@babel/core": "7.13.8",
     "@babel/eslint-parser": "7.13.8",
-    "@semantic-release/changelog": "5.0.1",
     "@semantic-release/git": "9.0.0",
+    "@semantic-release/release-notes-generator": "9.0.1",
     "any-shell-escape": "0.1.1",
     "browserify": "17.0.0",
     "chai": "4.3.0",

release.config.js

@@ -1,18 +1,34 @@
+/* eslint-disable object-property-newline */
 const isCI = require('is-ci');
 // eslint-disable-next-line global-require, no-unused-expressions
 !isCI && require('dotenv').config({path: './.env'});
 
 module.exports = {
   branches: [
-    // eslint-disable-next-line object-property-newline
     {name: 'main', prerelease: 'main'},
     {name: 'master'},
-    // eslint-disable-next-line object-property-newline
     {name: 'canary', prerelease: 'canary'}
   ],
   extends: [],
   plugins: [
-    '@semantic-release/changelog',
+    // @note(deprecate) move to release notes for multi-channel releases
+    // '@semantic-release/changelog',
+    [
+      '@semantic-release/commit-analyzer',
+      {
+        parserOpts: {
+          noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING']
+        }
+      }
+    ],
+    [
+      '@semantic-release/release-notes-generator',
+      {
+        parserOpts: {
+          noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING']
+        }
+      }
+    ],
     '@semantic-release/npm',
     '@semantic-release/git'
   ]

yarn.lock

@@ -818,16 +818,6 @@
   dependencies:
     "@octokit/openapi-types" "^5.2.0"
 
-"@semantic-release/changelog@5.0.1":
-  version "5.0.1"
-  resolved "https://registry.yarnpkg.com/@semantic-release/changelog/-/changelog-5.0.1.tgz#50a84b63e5d391b7debfe021421589fa2bcdafe4"
-  integrity sha512-unvqHo5jk4dvAf2nZ3aw4imrlwQ2I50eVVvq9D47Qc3R+keNqepx1vDYwkjF8guFXnOYaYcR28yrZWno1hFbiw==
-  dependencies:
-    "@semantic-release/error" "^2.1.0"
-    aggregate-error "^3.0.0"
-    fs-extra "^9.0.0"
-    lodash "^4.17.4"
-
 "@semantic-release/commit-analyzer@^8.0.0":
   version "8.0.1"
   resolved "https://registry.yarnpkg.com/@semantic-release/commit-analyzer/-/commit-analyzer-8.0.1.tgz#5d2a37cd5a3312da0e3ac05b1ca348bf60b90bca"
@@ -901,7 +891,7 @@
     semver "^7.1.2"
     tempy "^1.0.0"
 
-"@semantic-release/release-notes-generator@^9.0.0":
+"@semantic-release/release-notes-generator@9.0.1", "@semantic-release/release-notes-generator@^9.0.0":
   version "9.0.1"
   resolved "https://registry.yarnpkg.com/@semantic-release/release-notes-generator/-/release-notes-generator-9.0.1.tgz#732d285d103064f2a64f08a32031551ebb4f918b"
   integrity sha512-bOoTiH6SiiR0x2uywSNR7uZcRDl22IpZhj+Q5Bn0v+98MFtOMhCxFhbrKQjhbYoZw7vps1mvMRmFkp/g6R9cvQ==