chore: Add PR creation guidelines to AGENTS.md #670
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Checks | |
| on: | |
| pull_request: | |
| workflow_dispatch: | |
| schedule: | |
| - cron: '41 16 * * *' # Every day at 16:41 UTC (to avoid high load at exact hour values). | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| UV_NO_SYNC: 1 | |
| jobs: | |
| tests: | |
| # Default config: py3.14, ubuntu-latest, float32, full options. | |
| # The idea is to make each of those params vary one by one, to limit the number of tests to run. | |
| name: Tests (py${{ matrix.python-version || '3.14' }}, ${{ matrix.os || 'ubuntu-latest' }}, ${{ matrix.dtype || 'float32' }}, ${{ matrix.options || 'full' }}${{ matrix.extra_groups && format(', {0}', matrix.extra_groups) || '' }}) | |
| runs-on: ${{ matrix.os || 'ubuntu-latest' }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| # Python version variations | |
| - python-version: '3.10' | |
| - python-version: '3.11' | |
| - python-version: '3.12' | |
| - python-version: '3.13' | |
| - python-version: '3.14' # To actually run the default config | |
| # OS variations | |
| - os: macOS-latest | |
| - os: windows-latest | |
| # dtype variations | |
| - dtype: float64 | |
| # Installation options variations | |
| - options: 'none' | |
| # Lower-bounds of all dependencies and Python version. | |
| - python-version: '3.10.0' | |
| extra_groups: 'lower_bounds' | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: ${{ matrix.python-version || '3.14' }} | |
| - uses: ./.github/actions/install-deps | |
| with: | |
| options: ${{ matrix.options || 'full' }} | |
| groups: test ${{ matrix.extra_groups }} | |
| - name: Run unit tests | |
| run: uv run pytest -W error tests/unit --cov=src --cov-report=xml | |
| env: | |
| PYTEST_TORCH_DTYPE: ${{ matrix.dtype || 'float32' }} | |
| - name: Upload results to Codecov | |
| uses: codecov/codecov-action@v6 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| build-doc: | |
| name: Build and test documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: '3.14' | |
| - uses: ./.github/actions/install-deps | |
| with: | |
| groups: doc | |
| - name: Build Documentation | |
| working-directory: docs | |
| run: uv run make dirhtml | |
| - name: Test Documentation | |
| working-directory: docs | |
| run: uv run make doctest | |
| code-quality: | |
| name: Code quality (ty and pre-commit hooks) | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v6 | |
| - name: Set up uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| python-version: '3.14' | |
| - uses: ./.github/actions/install-deps | |
| with: | |
| groups: check test plot | |
| - name: Run pre-commit hooks | |
| run: uv run pre-commit run --all-files | |
| - name: Run ty | |
| run: uv run ty check --output-format=github |