build.yml

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Tests

on:
  push:
    tags: '*'
    branches: [ master, main ]
  pull_request:
    branches: [ master, main ]

jobs:
  verify_style:
    runs-on: 'ubuntu-latest'
    steps:
      -
        uses: actions/checkout@v4
      -
        name: Set up Python 3
        uses: actions/setup-python@v4
        with:
          python-version: '3.x'
          architecture: 'x64'
      -
        name: Install dependencies
        run: |
          python -m pip install --upgrade pip invoke typing-extensions
          invoke setup --devel --tests
          python/bin/python -m pip install black==19.3b0 click==8.0.1

      -
        name: Lint with flake8
        run: |
          # stop the build if there are Python syntax errors or undefined names
          python/bin/python -m flake8 instruct/ --count --select=E9,F63,F7,F82 --show-source --statistics
          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
          python/bin/python -m flake8 instruct/ --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
      -
        name: Check style with black
        run: |
          python/bin/python -m black --check

  test_matrix:
    needs: [verify_style]
    strategy:
      fail-fast: false
      matrix:
        arch:
          - 'x64'
        python_version:
          - '3.7'
          - '3.8'
          - '3.9'
          - '3.10'
          - '3.11'
          - '3.12'
          - 'pypy3.7'
          - 'pypy3.8'
          - 'pypy3.9'
          - 'pypy3.10'
        os:
          - 'ubuntu-latest'
    runs-on: ${{ matrix.os }}
    steps:
      -
        uses: actions/checkout@v4
      -
        name: Set up Python ${{ matrix.python_version }}
        uses: actions/setup-python@v4
        with:
          python-version: ${{ matrix.python_version }}
          architecture: ${{ matrix.arch }}
      -
        name: Install dependencies
        run: |
          python -m pip install --upgrade pip invoke typing-extensions
          invoke setup --tests
      -
        name: Test with pytest
        run: |
          python/bin/python -m pytest

  pypi-publish:
    needs: [test_matrix, verify_style]
    runs-on: 'ubuntu-latest'
    environment:
      name: pypi
      url: https://pypi.org/p/instruct
    permissions:
      id-token: write
    steps:
      -
        uses: actions/checkout@v4
      -
        name: Set up Python 3.11
        uses: actions/setup-python@v4
        with:
          python-version: '3.11'
          architecture: 'x64'
      -
        name: Set some variables...
        id: version
        run: |
          echo "GIT_VERSION=$(echo '${{ github.ref_name }}' | sed 's/^.//')" >> "$GITHUB_OUTPUT"
          echo "CURRENT_VERSION=$(grep -vE '^#' CURRENT_VERSION.txt | head -1)" >> "$GITHUB_OUTPUT"

      -
        name: Assert tag version matches the source version
        run: |
          if [ 'x${{ steps.version.outputs.GIT_VERSION }}' != 'x${{ steps.version.outputs.CURRENT_VERSION }}' ]; then
          if [ 'x${{ github.ref_type }}' = 'xtag']; then
            echo '::error file=CURRENT_VERSION.txt,line=2,title=Version mismatch::Expected ${{ steps.version.outputs.GIT_VERSION }} but got ${{ steps.version.outputs.CURRENT_VERSION }} instead.
            Suggest you fix that and delete the tag.'
            exit 254
          else
            echo '::warn file=CURRENT_VERSION.txt,line=2,title=Version mismatch::Expected ${{ steps.version.outputs.GIT_VERSION }} but got ${{ steps.version.outputs.CURRENT_VERSION }} instead.

            If you make a tag from this, it *will* error out.'
          fi
          fi
      -
        name: Install dependencies
        run: |
          python -m pip install --upgrade pip invoke typing-extensions
          invoke setup --devel --no-project
      -
        name: Create artifacts
        run: |
          python/bin/python -m build

      -
        name: Publish package distributions to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1
        if: ${{ github.ref_type == 'tag' && startsWith(github.ref, 'refs/tags/v') }}
        with:
          skip-existing: false

      # -
      #   name: Create Release
      #   if: false
      #   id: create_release
      #   uses: actions/create-release@latest
      #   env:
      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      #   with:
      #     tag_name: ${{ github.ref }}
      #     release_name: Release ${{ steps.version.outputs.CURRENT_VERSION }}
      #     body: |
      #       Changes in this Release
      #       - First Change
      #       - Second Change
      #     draft: false
      #     prerelease: false