main.yml

# see https://github.com/karlicoss/pymplate for up-to-date reference

name: CI
on:
  push:
    branches: '*'
    tags: 'v[0-9]+.*' # only trigger on 'release' tags for PyPi
    # Ideally I would put this in the pypi job... but github syntax doesn't allow for regexes there :shrug:

  # Needed to trigger on others' PRs.
  # Note that people who fork it need to go to "Actions" tab on their fork and click "I understand my workflows, go ahead and enable them".
  pull_request:

  # Needed to trigger workflows manually.
  workflow_dispatch:
    inputs:
      debug_enabled:
        type: boolean
        description: 'Run the build with tmate debugging enabled (https://github.com/marketplace/actions/debugging-with-tmate)'
        required: false
        default: false

  schedule:
    - cron: '31 18 * * 5'  # run every Friday


jobs:
  build:
    strategy:
      fail-fast: false
      matrix:
        platform: [ubuntu-latest, macos-latest, windows-latest]
        python-version: ['3.12', '3.13', '3.14']
        exclude: [
            # windows runners are pretty scarce, so let's only run lowest and highest python version
            {platform: windows-latest, python-version: '3.13'},

            # same, macos is a bit too slow and ubuntu covers python quirks well
            {platform: macos-latest  , python-version: '3.13'},
        ]

    runs-on: ${{ matrix.platform }}

    # useful for 'optional' pipelines
    # continue-on-error: ${{ matrix.platform == 'windows-latest' }}

    steps:
    - uses: actions/checkout@v6
      with:
        submodules: recursive
        fetch-depth: 0  # nicer to have all git history when debugging/for tests

    - uses: astral-sh/setup-uv@v8.1.0
      with:
        python-version: ${{ matrix.python-version }}
        enable-cache: false  # we don't have lock files during initial CI checkout, so can't use them as cache key

    - uses: mxschmitt/action-tmate@v3
      with:
        limit-access-to-actor: true  # restrict to the user who kicked off pipeline
      if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}

    # explicit bash command is necessary for Windows CI runner, otherwise it thinks it's cmd...
    - run: bash .ci/run


  pypi:
    # Do not run it for PRs/cron schedule etc.
    # NOTE: release tags are guarded by on: push: tags on the top.
    if: github.event_name == 'push' && (github.ref_type == 'tag' || github.ref_name == github.event.repository.master_branch)
    # Ugh, I tried using matrix or something to explicitly generate only test pypi or prod pypi pipelines.
    # But github actions is so shit, it's impossible to do any logic at all, e.g. doesn't support conditional matrix, if/else statements for variables etc.

    needs: [build, end2end_tests, install_and_run_test] # add all other jobs here

    runs-on: ubuntu-latest

    permissions:
      # necessary for Trusted Publishing
      id-token: write
    env:
      # always deploy merged master to test pypi
      # always deploy tags to release pypi
      TARGET:      ${{ github.ref_type == 'tag' && 'pypi'     || 'testpypi' }}
    environment:
      # for "deployments" tab on github
      # sadly can't reuse env.TARGET here...
      name:        ${{ github.ref_type == 'tag' && 'pypi'     || 'testpypi' }}
      url: https://${{ github.ref_type == 'tag' && 'pypi.org' || 'test.pypi.org' }}/project/${{ steps.meta.outputs.pypi_name }}/
    steps:
    - uses: actions/checkout@v6
      with:
        submodules: recursive
        fetch-depth: 0  # pull all commits to correctly infer vcs version

    - uses: astral-sh/setup-uv@v8.1.0
      with:
        python-version: '3.12'
        enable-cache: false  # we don't have lock files during initial CI checkout, so can't use them as cache key

    - name: 'release ${{ steps.meta.outputs.pypi_name }} to ${{ env.TARGET }}'
      run: .ci/release ${{ env.TARGET == 'testpypi' && '--use-test-pypi' || '' }}

    - id: meta
      shell: bash
      run: |
        pypi_name=$(unzip -p dist/*.whl '*.dist-info/METADATA' | awk '/^Name:/ {print $2; exit}')
        echo "pypi_name=$pypi_name" >> "$GITHUB_OUTPUT"

  ###
  build_extension:
    env:
      name: 'promnesia'
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6
      with:
        submodules: recursive
        fetch-depth: 0  # nicer to have all git history when debugging/for tests

    - uses: actions/setup-node@v6
      with:
        node-version: '24'

    - run: extension/.ci/build --lint # debug version
    - run: extension/.ci/build --lint --release

    # TODO ugh. can't share github actions artifacts publicly...
    # TODO for fuck's sake... why does it end up named as .zip.zip ????
    - uses: actions/upload-artifact@v6
      with:
        name: '${{ env.name }}-chrome-debug-latest.zip'
        path: 'extension/dist/artifacts/chrome/${{ env.name }}_dev_-*.zip'
    - uses: actions/upload-artifact@v6
      with:
        name: '${{ env.name }}-chrome-release-latest.zip'
        path: 'extension/dist/artifacts/chrome/${{ env.name }}-*.zip'
    - uses: actions/upload-artifact@v6
      with:
        name: '${{ env.name }}-firefox-debug-latest.zip'
        path: 'extension/dist/artifacts/firefox/${{ env.name }}_dev_-*.zip'
    - uses: actions/upload-artifact@v6
      with:
        name: '${{ env.name }}-firefox-release-latest.zip'
        path: 'extension/dist/artifacts/firefox/${{ env.name }}-*.zip'

  # split in two pipelines to speedup running
  end2end_tests:
    strategy:
      fail-fast: false
      matrix:
        browser: [chrome, firefox]

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v6
      with:
        submodules: recursive
        fetch-depth: 0  # nicer to have all git history when debugging/for tests

    - uses: actions/setup-node@v6
      with:
        node-version: '24'

    - uses: astral-sh/setup-uv@v8.1.0
      with:
        python-version: '3.12'
        enable-cache: false  # we don't have lock files during initial CI checkout, so can't use them as cache key

    - uses: mxschmitt/action-tmate@v3
      with:
        limit-access-to-actor: true  # restrict to the user who kicked off pipeline
      if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}

    - run: sudo apt update && sudo apt install --yes python3-doc  # html files from this pacakge are used in tests
    - run: extension/.ci/build  # debug version, don't lint since build_extension already did that
    # -n is used to run in parallel (pytes-xdist)
    - run: bash .ci/run -e end2end -- -k ${{ matrix.browser }} -n auto

  install_and_run_test:
    # todo use setup-python thing?
    # todo run on macos too?
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6
      with:
        submodules: recursive
    - uses: mxschmitt/action-tmate@v3
      with:
        limit-access-to-actor: true  # restrict to the user who kicked off pipeline
      if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}

    - run: .ci/github-ci-compat

    - run: |
        python3 -m pip install .
        export PATH=.ci/fake-systemd:$PATH
        tests/install_and_run