Bump furo from 2024.1.29 to 2024.8.6 #705
This file contains 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: CI | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - 'v*.*.*' | |
| env: | |
| # Change this to invalidate existing cache. | |
| CACHE_PREFIX: v0 | |
| PYTHON_PATH: ./ | |
| DEFAULT_PYTHON: '3.10' | |
| jobs: | |
| checks: | |
| name: python ${{ matrix.python }} - ${{ matrix.task.name }} | |
| runs-on: [ubuntu-latest] | |
| timeout-minutes: 30 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python: ['3.8', '3.9', '3.10'] | |
| task: | |
| - name: Test | |
| run: | | |
| pytest -v --color=yes --doctest-modules --doctest-glob='*.md' | |
| include: | |
| - python: '3.10' | |
| task: | |
| name: Lint | |
| run: ruff check . | |
| - python: '3.10' | |
| task: | |
| name: Type check | |
| run: mypy . | |
| - python: '3.10' | |
| task: | |
| name: Build | |
| run: | | |
| python -m build | |
| - python: '3.10' | |
| task: | |
| name: Style | |
| run: black --check . | |
| - python: '3.10' | |
| task: | |
| name: Docs | |
| run: cd docs && make html | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| - name: Install prerequisites | |
| run: | | |
| pip install --upgrade pip setuptools wheel virtualenv | |
| - name: Set build variables | |
| shell: bash | |
| run: | | |
| # Get the exact Python version to use in the cache key. | |
| echo "PYTHON_VERSION=$(python --version)" >> $GITHUB_ENV | |
| echo "RUNNER_ARCH=$(uname -m)" >> $GITHUB_ENV | |
| # Use week number in cache key so we can refresh the cache weekly. | |
| echo "WEEK_NUMBER=$(date +%V)" >> $GITHUB_ENV | |
| - uses: actions/cache@v4 | |
| id: virtualenv-cache | |
| with: | |
| path: .venv | |
| key: ${{ env.CACHE_PREFIX }}-${{ env.WEEK_NUMBER }}-${{ runner.os }}-${{ env.RUNNER_ARCH }}-${{ env.PYTHON_VERSION }}-${{ hashFiles('pyproject.toml') }} | |
| - name: Setup virtual environment (no cache hit) | |
| if: steps.virtualenv-cache.outputs.cache-hit != 'true' | |
| run: | | |
| test -d .venv || virtualenv -p $(which python) --copies --reset-app-data .venv | |
| . .venv/bin/activate | |
| pip install -e .[dev] | |
| - name: Install editable (cache hit) | |
| if: steps.virtualenv-cache.outputs.cache-hit == 'true' | |
| run: | | |
| . .venv/bin/activate | |
| pip install --no-deps -e .[dev] | |
| - name: Show environment info | |
| run: | | |
| . .venv/bin/activate | |
| which python | |
| python --version | |
| pip freeze | |
| - name: ${{ matrix.task.name }} | |
| env: | |
| BEAKER_TOKEN: ${{ secrets.BEAKER_TOKEN }} | |
| run: | | |
| . .venv/bin/activate | |
| ${{ matrix.task.run }} | |
| - name: Upload package distribution files | |
| if: matrix.task.name == 'Build' && matrix.python == env.DEFAULT_PYTHON | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: package | |
| path: dist | |
| - name: Clean up | |
| if: always() | |
| run: | | |
| . .venv/bin/activate | |
| pip uninstall -y cached_path | |
| release: | |
| name: Release | |
| runs-on: ubuntu-latest | |
| needs: [checks] | |
| if: startsWith(github.ref, 'refs/tags/') | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - name: Setup Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.DEFAULT_PYTHON }} | |
| - name: Install requirements | |
| run: | | |
| pip install --upgrade pip setuptools wheel build | |
| pip install -e .[dev] | |
| - name: Prepare environment | |
| run: | | |
| echo "RELEASE_VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV | |
| echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV | |
| - name: Download package distribution files | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: package | |
| path: dist | |
| - name: Generate release notes | |
| run: | | |
| python scripts/release_notes.py > ${{ github.workspace }}-RELEASE_NOTES.md | |
| - name: Publish package to PyPI | |
| run: | | |
| twine upload -u __token__ -p ${{ secrets.PYPI_PASSWORD }} dist/* | |
| - name: Publish GitHub release | |
| uses: softprops/action-gh-release@v1 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| body_path: ${{ github.workspace }}-RELEASE_NOTES.md | |
| prerelease: ${{ contains(env.TAG, 'rc') }} | |
| files: | | |
| dist/* |