build-cli.yml

---
name: build cli

on:
  push:
    tags:
      - pact-python-cli/*
    branches:
      - main
  pull_request:
    branches:
      - main

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
  cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
  STABLE_PYTHON_VERSION: '310'
  HATCH_VERBOSE: '1'
  FORCE_COLOR: '1'
  CIBW_BUILD_FRONTEND: build

jobs:
  complete:
    name: Build CLI completion check
    if: always()

    permissions:
      contents: none

    runs-on: ubuntu-latest
    needs:
      - build-sdist
      - build-wheels
      - publish

    steps:
      - name: Failed
        run: exit 1
        if: contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')

  build-sdist:
    name: Build CLI source distribution

    runs-on: ubuntu-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
        with:
          fetch-depth: 0

      - name: Set up uv
        uses: astral-sh/setup-uv@cec208311dfd045dd5311c1add060b2062131d57  # v8.0.0
        with:
          enable-cache: true

      - name: Install Python
        run: uv python install ${{ env.STABLE_PYTHON_VERSION }}

      - name: Install hatch
        run: uv tool install hatch

      - name: Create source distribution
        working-directory: pact-python-cli
        run: hatch build --target sdist

      - name: Upload sdist
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: wheels-sdist
          path: pact-python-cli/dist/*.tar*
          if-no-files-found: error
          compression-level: 0

  build-wheels:
    name: Build CLI wheels on ${{ matrix.os }}

    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        include:
          - os: macos-15-intel
          - os: macos-latest
          - os: ubuntu-24.04-arm
          - os: ubuntu-latest
          # - os: windows-11-arm  # Not supported upstream
          - os: windows-latest

    steps:
      - name: Checkout code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
        with:
          fetch-depth: 0

      - name: Create wheels
        uses: pypa/cibuildwheel@8d2b08b68458a16aeb24b64e68a09ab1c8e82084  # v3.4.1
        with:
          package-dir: pact-python-cli
        env:
          CIBW_BUILD: cp${{ env.STABLE_PYTHON_VERSION }}-*

      - name: Upload wheels
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
        with:
          name: wheels-${{ matrix.os }}
          path: wheelhouse/*.whl
          if-no-files-found: error
          compression-level: 0

  publish:
    name: Publish CLI wheels and sdist

    if: >-
      github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/pact-python-cli/')
    runs-on: ubuntu-latest
    environment:
      name: pypi
      url: https://pypi.org/p/pact-python-cli

    needs:
      - build-sdist
      - build-wheels

    permissions:
      # Required for creating the release
      contents: write
      # Required for trusted publishing
      id-token: write

    steps:
      - name: Checkout code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
        with:
          fetch-depth: 0

      - name: Install git cliff and typos
        uses: taiki-e/install-action@0abfcd587b70a713fdaa7fb502c885e2112acb15  # v2.75.7
        with:
          tool: git-cliff,typos

      - name: Update changelog
        run: git cliff --verbose
        working-directory: pact-python-cli
        env:
          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

      - name: Generate release changelog
        id: release-changelog
        working-directory: pact-python-cli
        run: |
          if ! git cliff \
            --current \
            --strip header \
            --output ${{ runner.temp }}/release-changelog.md; then
            {
              echo "> [!WARNING]"
              echo ">"
              echo "> No changelog generated. To be filled in."
            } > ${{ runner.temp }}/release-changelog.md
          fi

          {
            echo ""
            echo "<details>"
            echo "<summary>"
            echo ""
            echo "## Pull Requests"
            echo ""
            echo "</summary>"
            echo ""
          } >> ${{ runner.temp }}/release-changelog.md
        env:
          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

      - name: Download wheels and sdist
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
        with:
          path: wheelhouse
          merge-multiple: true

      - name: Generate release
        id: release
        uses: softprops/action-gh-release@b4309332981a82ec1c5618f44dd2e27cc8bfbfda  # v3.0.0
        with:
          files: wheelhouse/*
          body_path: ${{ runner.temp }}/release-changelog.md
          draft: false
          prerelease: false
          generate_release_notes: true

      - name: Push build artifacts to PyPI
        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # v1.14.0
        with:
          skip-existing: true
          packages-dir: wheelhouse

      - name: Create PR for changelog update
        uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1  # v8.1.1
        with:
          token: ${{ secrets.GH_TOKEN }}
          commit-message: 'docs: update changelog for ${{ github.ref_name }}'
          title: 'docs: update cli changelog'
          body: |
            This PR updates the changelog for ${{ github.ref_name }}.
          branch: docs/update-changelog
          base: main