ci.yml

name: Run CI

on:
  push:
    branches: "*"
    tags: 'v[0-9]+![0-9]+.[0-9]+.[0-9]+*'
  pull_request:
    branches: "*"
  schedule:
    # run every Saturday at 11 EST / 12 EDT
    # because new Pydantic versions keep breaking things :(
    - cron: 0 16 * * 6

permissions:
  contents: read

env:
  PYPI_PACKAGE: hexdoc
  PYTHON_VERSION: '3.11'

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pages: read
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      HEXDOC_RELEASE: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags') }}
    outputs:
      release: ${{ env.HEXDOC_RELEASE }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - uses: yezz123/setup-uv@v4

      - name: Install display server
        uses: awalsh128/cache-apt-pkgs-action@v1
        with:
          packages: xvfb

      - name: Install dependencies
        run: uv pip install --system -e .

      - name: Export hexdoc resources
        run: xvfb-run --auto-servernum hexdoc ci build

      - name: Upload package artifact
        uses: actions/upload-artifact@v3
        with:
          name: python-build
          path: dist

  test:
    runs-on: ubuntu-latest
    env:
      HEXDOC_RELEASE: false
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true
          fetch-depth: 0
      - uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - uses: yezz123/setup-uv@v4

      - name: Install display server
        uses: awalsh128/cache-apt-pkgs-action@v1
        with:
          packages: xvfb

      - name: Run pre-commit hooks
        env:
          SKIP: pyright
        uses: pre-commit/action@v3.0.0

      - name: Install Nox
        run: uv pip install --system nox

      - name: Run Nox with display server
        run: xvfb-run --auto-servernum nox

  update-tags:
    runs-on: ubuntu-latest
    needs: [build, test]
    if: github.event_name == 'push' && needs.build.outputs.release == 'true'
    permissions:
      contents: write
    concurrency:
      group: update-tags-${{ github.sha }}
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v4
        with:
          python-version: ${{ env.PYTHON_VERSION }}
      - uses: yezz123/setup-uv@v4

      - name: Install Nox
        run: uv pip install --system nox packaging

      - name: Run Nox
        run: nox --session tag

      - name: Push new tags
        run: git push --tags --force

  publish-pypi:
    runs-on: ubuntu-latest
    needs: [build, test]
    if: github.event_name == 'push' && needs.build.outputs.release == 'true'
    environment:
      name: pypi
      url: https://pypi.org/p/${{ env.PYPI_PACKAGE }}
    permissions:
      id-token: write
    steps:
      - uses: actions/checkout@v4

      - name: Download package artifact
        uses: actions/download-artifact@v3
        with:
          name: python-build
          path: dist

      - name: Publish to PyPI
        uses: pypa/gh-action-pypi-publish@release/v1