Prepare for release (#1)

* add script to get the release notes

Usage:
```sh
npm run release-notes         # Gets notes for current version
npm run release-notes 1.2.3   # Gets notes for explicit version
```

* add actions for preparing a release, and releasing a release

The `prepare release` will be executed when a tag is pushed. It does the
following things:

1. Checks out the repo
2. Installs the dependencies
3. Runs the tests
4. Creates a draft release on GitHub with the release notes pre-filled
   based on the `CHANGELOG.md` file of the current version.

Once you publish the actual release on GitHub, the `release` action will
run. This will execute the following steps:

1. Checks out the repo
2. Installs the dependencies
3. Runs the tests as a sanity check
4. Published the current version to npm

* use `SHA_SHORT` for env variables

Author: RobinMalfait

.github/workflows/prepare-release.yml

@@ -0,0 +1,73 @@
+name: Prepare Release
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v*'
+
+env:
+  CI: true
+
+permissions:
+  contents: read
+
+jobs:
+  prepare:
+    permissions:
+      contents: write  # for softprops/action-gh-release to create GitHub release
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: 'https://registry.npmjs.org'
+      #     cache: 'npm'
+      #
+      # - name: Use cached node_modules
+      #   id: cache
+      #   uses: actions/cache@v3
+      #   with:
+      #     path: node_modules
+      #     key: nodeModules-${{ hashFiles('**/package-lock.json') }}-${{ matrix.node-version }}
+      #     restore-keys: |
+      #       nodeModules-
+
+      - name: Resolve version
+        id: vars
+        run: |
+          echo "TAG_NAME=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
+
+      - name: Get release notes
+        run: |
+          RELEASE_NOTES=$(npm run release-notes --silent)
+          echo "RELEASE_NOTES<<EOF" >> $GITHUB_ENV
+          echo "$RELEASE_NOTES" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: Install dependencies
+        # if: steps.cache.outputs.cache-hit != 'true'
+        run: npm install
+        env:
+          CI: true
+
+      - name: Test
+        run: npm test
+        env:
+          CI: true
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          draft: true
+          tag_name: ${{ env.TAG_NAME }}
+          body: ${{ env.RELEASE_NOTES }}            

.github/workflows/release-insiders.yml

@@ -39,10 +39,10 @@ jobs:
       - name: Resolve version
         id: vars
         run: | 
-          echo "sha_short=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
+          echo "SHA_SHORT=$(git rev-parse --short HEAD)" >> $GITHUB_ENV
 
-      - name: "Version based on commit: 0.0.0-insiders.${{ env.sha_short }}"
-        run: npm version 0.0.0-insiders.${{ env.sha_short }} --force --no-git-tag-version
+      - name: "Version based on commit: 0.0.0-insiders.${{ env.SHA_SHORT }}"
+        run: npm version 0.0.0-insiders.${{ env.SHA_SHORT }} --force --no-git-tag-version
 
       - name: Publish
         run: npm publish --tag insiders

.github/workflows/release.yml

@@ -0,0 +1,56 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: 'https://registry.npmjs.org'
+      #     cache: 'npm'
+      #
+      # - name: Use cached node_modules
+      #   id: cache
+      #   uses: actions/cache@v3
+      #   with:
+      #     path: node_modules
+      #     key: nodeModules-${{ hashFiles('**/package-lock.json') }}-${{ matrix.node-version }}
+      #     restore-keys: |
+      #       nodeModules-
+
+      - name: Install dependencies
+        # if: steps.cache.outputs.cache-hit != 'true'
+        run: npm install
+        env:
+          CI: true
+
+      - name: Test
+        run: npm test
+        env:
+          CI: true
+
+      - name: Calculate environment variables
+        run: |
+          echo "TAG_NAME=$(npm run calculate-tag-name --silent)" >> $GITHUB_ENV
+
+      - name: Publish
+        run: npm publish --tag ${{ env.TAG_NAME }}
+        env:
+          CI: true
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package.json

@@ -14,7 +14,8 @@
     "build": "npm run swcify",
     "dev": "npm run swcify -- --watch",
     "postbuild": "tsc --emitDeclarationOnly",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "release-notes": "node ./scripts/release-notes.js"
   },
   "prettier": {
     "printWidth": 100,

scripts/release-notes.js

@@ -0,0 +1,16 @@
+let path = require('path')
+let fs = require('fs')
+
+let version = process.argv[2] || require('../package.json').version
+let changelog = fs.readFileSync(path.resolve(__dirname, '..', 'CHANGELOG.md'), 'utf8')
+let match = new RegExp(
+  `## \\[${version}\\] - (.*)\\n\\n([\\s\\S]*?)\\n(?:(?:##\\s)|(?:\\[))`,
+  'g'
+).exec(changelog)
+
+if (match) {
+  let [, date, notes] = match
+  console.log(notes.trim())
+} else {
+  console.log(`Placeholder release notes for version: v${version}`)
+}