ci: modernize github release script

We address the following issues in CI:

- Node 12 deprecation: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/
  To do that we upgrade actions/checkout and actions/setup-python to v3.
- Deprecated set-output command: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
- Get rid of the actions/upload-files-to-a-github-release action to use the gh
  script which ships by default in GitHub hosted runners: https://github.com/cli/cli

Unfortunately we could not get rid of the ugly `sed` in `make
release-description`. I wish we could use `envsubst` but it's not available on
GitHub action runners.

.github/workflows/release.yml

@@ -1,3 +1,9 @@
+# This script can be tested locally with act:
+#
+#    act --secret GITHUB_TOKEN=... --job release
+#
+# https://github.com/nektos/act/
+# To generate a token: https://github.com/settings/tokens
 name: Release
 
 on:
@@ -11,21 +17,27 @@ jobs:
     strategy:
       matrix:
         include:
+          # https://github.com/actions/runner-images#available-images
           - os: ubuntu-latest
             locale: C.UTF-8
-          - os: macos-10.15
+          # https://endoflife.date/macos
+          - os: macos-latest
             locale: en_US.UTF-8
     env:
       LC_ALL: ${{ matrix.locale }}
       LANG: ${{ matrix.locale }}
     steps:
-      - uses: actions/checkout@v2
+      # https://github.com/actions/checkout
+      - uses: actions/checkout@v3
       - name: Set up Python
-        uses: actions/setup-python@v2
+        # https://github.com/actions/setup-python
+        uses: actions/setup-python@v3
         with:
           python-version: 3.7
-      - name: Upgrade pip
+      - name: Upgrade pip and setuptools
-        run: python -m pip install --upgrade pip setuptools==44.0.0
+        # https://pypi.org/project/pip/
+        # https://pypi.org/project/setuptools/
+        run: python -m pip install --upgrade pip setuptools==65.6.3
       - name: Print info about the current python installation
         run: make ci-info
       - name: Install requirements
@@ -36,41 +48,31 @@ jobs:
         run: make bundle
       - name: Test bundle
         run: make ci-test-bundle
-      - name: Get release description
+      - name: Check for presence of "gh" CLI utility
-        id: release-description
+        run: echo "gh_bin=$(which gh)" >> $GITHUB_ENV
-        # We must escape multi-line string, as per:
+      - name: Download gh utility (linux)
-        # https://medium.com/agorapulse-stories/how-to-work-with-multiline-string-variables-in-github-actions-23f56447d209
         run: |
-          make release-description
+          curl -L -o gh.tar.gz https://github.com/cli/cli/releases/download/v2.20.2/gh_2.20.2_linux_amd64.tar.gz
-          cat release_description.md
+          tar xzf gh.tar.gz
-          description="$(cat release_description.md)"
+          echo "gh_bin=./gh_2.20.2_linux_amd64/bin/gh" >> $GITHUB_ENV
-          description="${description//'%'/'%25'}"
+        if: ${{ env.gh_bin == '' && !contains(matrix.os, 'macos') }}
-          description="${description//$'\n'/'%0A'}"
+      - name: Download gh utility (macos)
-          description="${description//$'\r'/'%0D'}"
-          echo "::echo::on"
-          echo "::set-output name=text::$description"
-          echo "::echo::off"
-        shell: bash
-      - name: Get release file name
-        id: release-file
         run: |
-          echo "::echo::on"
+          curl -L -o gh.tar.gz https://github.com/cli/cli/releases/download/v2.20.2/gh_2.20.2_macOS_amd64.tar.gz
-          echo "::set-output name=filename::tutor-$(uname -s)_$(uname -m)"
+          tar xzf gh.tar.gz
-          echo "::echo::off"
+          echo "gh_bin=./gh_2.20.2_macOS_amd64/bin/gh" >> $GITHUB_ENV
-        shell: bash
+        if: ${{ env.gh_bin == '' && contains(matrix.os, 'macos') }}
-      - name: Get release name
+      - name: Create or update GitHub release
-        id: release-name
+        # I wish there was an `--update` option to the `gh release create` command, but
+        # there isn't.
+        # https://cli.github.com/manual/gh_release_create
         run: |
-          echo "::echo::on"
+          make release-description | tee release_description.md
-          echo "::set-output name=release::${{ github.ref }}"
+          export GH_ARGS="${{ github.ref }} --notes-file=release_description.md"
-          echo "::echo::off"
+          echo "gh args: '$GH_ARGS"
-      - name: Upload bundle
+          ${{ env.gh_bin }} release create $GH_ARGS || ${{ env.gh_bin }} release edit $GH_ARGS
-        # https://github.com/marketplace/actions/upload-files-to-a-github-release
+      - name: Upload release asset to GitHub
-        uses: svenstaro/upload-release-action@v2
+        run: |
-        with:
+          export FILENAME="tutor-$(uname -s)_$(uname -m)"
-          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          mv ./dist/tutor $FILENAME
-          file: ./dist/tutor
+          ${{ env.gh_bin }} release upload --clobber ${{ github.ref }} $FILENAME
-          asset_name: "${{ steps.release-file.outputs.filename }}"
-          tag: "${{ steps.release-name.outputs.release }}"
-          overwrite: true
-          body: "${{ steps.release-description.outputs.text }}"

.gitignore

@@ -6,7 +6,6 @@ __pycache__
 
 /build/
 /dist/
-/release_description.md
 
 # Unit test/ coverage reports
 .coverage

Makefile

@@ -104,8 +104,8 @@ release-push:
 	git push origin $(TAG)
 
 release-description:  ## Write the current release description to a file
-	sed "s/TUTOR_VERSION/v$(shell make version)/g" docs/_release_description.md > release_description.md
+	@sed "s/TUTOR_VERSION/v$(shell make version)/g" docs/_release_description.md
-	git log -1 --pretty=format:%b >> release_description.md
+	@git log -1 --pretty=format:%b
 
 ###### Continuous integration tasks
 

docs/_release_description.md

@@ -10,3 +10,4 @@ Or download the compiled binaries:
 See the [installation docs](https://docs.tutor.overhang.io/install.html) for more installation options and instructions.
 
 ## Changes
+