tests.yml

name: continuous-integration

on:
  push:
    branches: [master]
    tags:
      - "v[0-9]+.[0-9]+.[0-9]+*"
  pull_request:

jobs:
  pre-commit:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v7
    - name: Set up Python 3.11
      uses: actions/setup-python@v7
      with:
        python-version: "3.11"
    - uses: pre-commit/action@v3.0.1

  tests:

    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.11", "3.12", "3.13", "3.14"]
        sphinx: [">=8,<9", ">=9,<10"]
        os: [ubuntu-latest]
        include:
        - os: windows-latest
          python-version: "3.11"
          sphinx: ">=8,<9"
        - os: windows-latest
          python-version: "3.14"
          sphinx: ">=9,<10"

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

    name: "pytest: py${{ matrix.python-version }}, sphinx${{ matrix.sphinx }}, on ${{ matrix.os }}"

    steps:
    - uses: actions/checkout@v7
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v7
      with:
        python-version: ${{ matrix.python-version }}
        allow-prereleases: true
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install -e ".[linkify,testing]" "sphinx${{ matrix.sphinx }}"
    - name: Run pytest
      run: pytest --cov=myst_parser --cov-report=xml --cov-report=term-missing
    - name: Create coverage report
      run: coverage xml
    # TODO there is currently problem with this action and pull-requests from external forks
    # - name: Upload to Codecov
    #   if: github.repository == 'executablebooks/MyST-Parser' && matrix.python-version == 3.11 && matrix.os == 'ubuntu-latest'
    #   uses: codecov/codecov-action@v4
    #   with:
    #     token: ${{ secrets.CODECOV_TOKEN }}
    #     name: myst-parser-pytests
    #     flags: pytests
    #     file: ./coverage.xml
    #     fail_ci_if_error: true

  check-myst-docutils:

    name: Check myst-docutils install
    runs-on: ubuntu-latest

    strategy:
      fail-fast: false
      matrix:
        docutils-version: ["0.20", "0.21", "0.22", "0.23"]

    steps:
    - name: Checkout source
      uses: actions/checkout@v7
    - name: Set up Python 3.11
      uses: actions/setup-python@v7
      with:
        python-version: "3.11"
    - name: Install setup
      run: |
        python -m pip install --upgrade pip
        pip install tomlkit
    - name: Modify setup
      run: python .github/workflows/docutils_setup.py pyproject.toml README.md
    - name: Install dependencies
      run: |
        pip install .[linkify,testing-docutils] docutils==${{ matrix.docutils-version }}
    - name: ensure sphinx is not installed
      run: |
        python -c "\
        try:
            import sphinx
        except ImportError:
            pass
        else:
            raise AssertionError()"
    - name: Run pytest for docutils-only tests
      run: pytest tests/test_docutils.py tests/test_renderers/test_fixtures_docutils.py tests/test_renderers/test_include_directive.py tests/test_renderers/test_myst_config.py
    - name: Run docutils CLI
      run: echo "test" | myst-docutils-html

  build:

    # Builds both distributions on every run, so a broken release build fails a PR, not a tag.
    # The publish jobs below upload exactly these files.
    name: Build distributions
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v7
      with:
        persist-credentials: false
    - name: Set up Python 3.13
      uses: actions/setup-python@v7
      with:
        python-version: "3.13"
    # `python -m build` uses the `[build-system]` pin in pyproject.toml,
    # so the release build cannot drift from it (an unpinned flit CLI can).
    - name: Install build tools
      run: python -m pip install build twine tomlkit
    - name: Build myst-parser
      run: python -m build --outdir dist-parser
    - name: Convert the project to myst-docutils
      run: python .github/workflows/docutils_setup.py pyproject.toml README.md
    - name: Build myst-docutils
      run: python -m build --outdir dist-docutils
    - name: Check the distributions
      run: python -m twine check --strict dist-parser/* dist-docutils/*
    - name: Check the distribution names, and the version against the tag
      env:
        TAG: ${{ startsWith(github.ref, 'refs/tags/') && github.ref_name || '' }}
      run: |
        python - <<'EOF'
        import os
        import pathlib
        import sys

        tag = os.environ["TAG"].removeprefix("v")
        errors = []
        for outdir, project in (("dist-parser", "myst_parser"), ("dist-docutils", "myst_docutils")):
            files = sorted(p.name for p in pathlib.Path(outdir).iterdir())
            wheels = [f for f in files if f.endswith(".whl")]
            sdists = [f.removesuffix(".tar.gz") for f in files if f.endswith(".tar.gz")]
            if len(files) != 2 or len(wheels) != 1 or len(sdists) != 1:
                errors.append(f"{outdir}: expected one wheel and one sdist, got {files}")
                continue
            names = {wheels[0].split("-")[0], sdists[0].rsplit("-", 1)[0]}
            versions = {wheels[0].split("-")[1], sdists[0].rsplit("-", 1)[1]}
            if names != {project}:
                errors.append(f"{outdir}: expected {project}, got {sorted(names)}")
            if tag and versions != {tag}:
                errors.append(f"{outdir}: tag v{tag} != built version(s) {sorted(versions)}")
            print(f"{outdir}: {files}")
        if errors:
            sys.exit("\n".join(errors))
        EOF
    - uses: actions/upload-artifact@v7
      with:
        name: dist-parser
        path: dist-parser/
        if-no-files-found: error
    - uses: actions/upload-artifact@v7
      with:
        name: dist-docutils
        path: dist-docutils/
        if-no-files-found: error

  # https://github.com/marketplace/actions/alls-green#why
  check:  # This job does nothing and is only used for the branch protection

    if: always()

    needs:
    - pre-commit
    - tests
    - check-myst-docutils
    - build

    runs-on: ubuntu-latest

    steps:
    - name: Decide whether the needed jobs succeeded or failed
      uses: re-actors/alls-green@release/v1
      with:
        jobs: ${{ toJSON(needs) }}

  publish:

    name: Publish myst-parser to PyPI
    needs:
    - check
    - build
    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
    runs-on: ubuntu-latest
    permissions:
      id-token: write
    environment:
      name: pypi
      url: https://pypi.org/p/myst-parser
    steps:
    - uses: actions/download-artifact@v8
      with:
        name: dist-parser
        path: dist-parser/
    - uses: pypa/gh-action-pypi-publish@release/v1
      with:
        packages-dir: dist-parser/

  publish-docutils:

    name: Publish myst-docutils to PyPI
    needs:
    - build
    - publish
    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
    runs-on: ubuntu-latest
    permissions:
      id-token: write
    environment:
      name: pypi
      url: https://pypi.org/p/myst-docutils
    steps:
    - uses: actions/download-artifact@v8
      with:
        name: dist-docutils
        path: dist-docutils/
    - uses: pypa/gh-action-pypi-publish@release/v1
      with:
        packages-dir: dist-docutils/