Release helper script and CI

.github/workflows/npm-publish.yml

@@ -0,0 +1,18 @@
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish-to-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: yarn --strict-semver --frozen-lockfile
+      - run: yarn build
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+on:
+  push:
+    tags: ["[0-9].[0-9].[0-9]"]
+
+jobs:
+  draft-release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Get changelog
+        id: extract-changelog
+        run: |
+          git fetch --tags --force
+          RELEASE_NAME="${{ github.ref_name }} $(date +'%Y-%m-%d')"
+          git tag -l --format='%(contents:body)' ${{ github.ref_name }} > next-changelog.txt
+          echo "RELEASE_NAME=$RELEASE_NAME" >> $GITHUB_OUTPUT
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: ${{ github.ref }}
+          name: ${{ steps.extract-changelog.outputs.RELEASE_NAME }}
+          body_path: next-changelog.txt
+          draft: true # Draft it
+          token: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token

.github/workflows/test.yml

@@ -3,7 +3,6 @@ name: Tests
 on:
   push:
   workflow_dispatch:
-  pull_request:
 
 jobs:
   lint:
@@ -12,7 +11,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: 16
       - run: yarn --strict-semver --frozen-lockfile
@@ -23,7 +22,6 @@ jobs:
       matrix:
         node-version: [16, 18]
     runs-on: ubuntu-20.04
-    container: node:14
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js
@@ -53,7 +51,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v3
         with:
           node-version: 18
       - run: yarn --frozen-lockfile

changelog.d/452.misc

@@ -0,0 +1 @@
+Add `release.sh` script to automate the release process.

scripts/release.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+# This script will run towncrier to and generate a release commit, tag and push to the origin.
+
+if ! command -v jq &> /dev/null
+then
+    echo "You must install jq to use this script"
+    exit
+fi
+
+VERSION=`jq -r .version package.json`
+TAG="$VERSION"
+
+if [[ "`git branch --show-current`" != "develop" ]]; then
+    echo "You must be on the develop branch to run this command."
+    exit 1
+fi
+
+if [ $(git tag -l "$TAG") ]; then
+    echo "Tag $TAG already exists, not continuing."
+    exit 1
+fi
+
+echo "Drafting a new release"
+towncrier build --draft --version $VERSION> draft-release.txt
+cat draft-release.txt
+
+read -p "Happy with the changelog? <y/N> " prompt
+if [[ $prompt != "y" && $prompt != "Y" && $prompt != "yes" && $prompt != "Yes" ]]
+then
+  exit 0
+fi
+
+echo "Committing version"
+towncrier build --version $VERSION
+git commit CHANGELOG.md changelog.d/ package.json -m $TAG
+
+echo "Proceeding to generate tags"
+cat draft-release.txt | git tag --force -m - -s $TAG
+rm draft-release.txt
+echo "Generated tag $TAG"
+
+echo "Pushing to origin"
+git push origin $TAG
+# Push develop too
+git push
+
+echo "The CI to generate a release is now running. Check https://github.com/matrix-org/matrix-appservice-bridge/releases and publish the release when it's ready."