tutor/.github/workflows/release.yml

# 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 (add r/w permissions for "Contents")
name: Release

on:
  push:
    tags:
      - '*'

jobs:
  release:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        include:
          # https://github.com/actions/runner-images#available-images
          # It's important that we build the tutor binaries with the *oldest* possible
          # OS releases and Python version. See these docs for more information:
          # https://pyinstaller.org/en/stable/usage.html#making-gnu-linux-apps-forward-compatible
          - os: ubuntu-20.04
            locale: C.UTF-8
            gh_os: linux
          # https://endoflife.date/macos
          - os: macos-10.15
            locale: en_US.UTF-8
            gh_os: macOs
    env:
      LC_ALL: ${{ matrix.locale }}
      LANG: ${{ matrix.locale }}
    steps:
      ##### Setup environment
      # https://github.com/actions/checkout
      - uses: actions/checkout@v3
      - name: Set up Python
        # https://github.com/actions/setup-python
        uses: actions/setup-python@v3
        with:
          python-version: 3.7
      - name: Upgrade pip and setuptools
        # https://pypi.org/project/pip/
        # https://pypi.org/project/setuptools/
        # https://pypi.org/project/wheel/
        run: python -m pip install --upgrade pip setuptools==65.6.3 wheel
      - name: Print info about the current python installation
        run: make ci-info
      - name: Install requirements
        run: make bootstrap-dev-plugins

      ##### Run tests, generate bundle
      - name: Run tests
        run: make test
      - name: Create bundle
        run: make bundle
      - name: Test bundle
        run: make ci-test-bundle

      ##### Download gh utility: https://github.com/cli/cli/releases
      - name: Check for presence of "gh" CLI utility
        run: echo "gh_bin=$(which gh)" >> $GITHUB_ENV
      - name: Download gh utility
        run: |
          curl -L -o gh.tar.gz https://github.com/cli/cli/releases/download/v2.20.2/gh_2.20.2_${{ matrix.gh_os }}_amd64.tar.gz
          tar xzf gh.tar.gz
          echo "gh_bin=./gh_2.20.2_${{ matrix.gh_os }}_amd64/bin/gh" >> $GITHUB_ENV
        if: ${{ env.gh_bin == '' }}

      ##### Create release on GitHub
      - name: Create or update GitHub release
        # 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: |
          make release-description | tee release_description.md
          export GH_ARGS="${{ github.ref_name }} --notes-file=release_description.md"
          echo "gh args: '$GH_ARGS'"
          ${{ env.gh_bin }} release create $GH_ARGS || ${{ env.gh_bin }} release edit $GH_ARGS
        env:
          GH_TOKEN: ${{ github.token }}
      - name: Upload release asset to GitHub
        run: |
          export FILENAME="tutor-$(uname -s)_$(uname -m)"
          mv ./dist/tutor $FILENAME
          ${{ env.gh_bin }} release upload --clobber ${{ github.ref_name }} $FILENAME
        env:
          GH_TOKEN: ${{ github.token }}