v1.2.0 #74
Workflow file for this run
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: Test package | |
| on: | |
| push: | |
| branches: | |
| - main | |
| tags: | |
| - 'v*' | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| test: | |
| name: Test package | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: | |
| - ubuntu-latest | |
| python-version: | |
| - "3.12" | |
| - "3.13" | |
| type: | |
| - test | |
| include: | |
| - os: macos-latest | |
| python-version: "3.13" | |
| type: test | |
| - os: ubuntu-latest | |
| python-version: "3.13" | |
| type: code style | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Update pip | |
| run: python -m pip install --upgrade pip | |
| # Tests | |
| - name: Install VHS | |
| if: ${{ matrix.type == 'test' && matrix.os == 'macos-latest' }} | |
| uses: charmbracelet/vhs-action@v2 | |
| with: | |
| path: "" | |
| - name: Install test dependencies | |
| if: ${{ matrix.type == 'test' }} | |
| run: python -m pip install . --group test | |
| - name: Check types | |
| if: ${{ matrix.type == 'test' }} | |
| run: pyright | |
| - name: Test package | |
| if: ${{ matrix.type == 'test' }} | |
| run: pytest -vv --showlocals --tb=short --color=yes --junit-xml=test-results.xml | |
| # Lint | |
| - name: Install lint dependencies | |
| if: ${{ matrix.type == 'code style' }} | |
| run: python -m pip install . --group lint | |
| - name: Check code style | |
| if: ${{ matrix.type == 'code style' }} | |
| run: pre-commit run -a | |
| publish_to_pypi: | |
| name: Publish package to PyPi | |
| needs: | |
| - test | |
| if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }} | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/p/sphinx-syntax | |
| permissions: | |
| contents: write | |
| id-token: write | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Generate release metadata | |
| id: metadata | |
| run: | | |
| ref="${{ github.ref }}"; | |
| version=${ref#refs/tags/v}; | |
| link="https://pypi.org/p/sphinx-vhs/${version}/"; | |
| echo "version=${version}" >> $GITHUB_OUTPUT | |
| echo "link=${link}" >> $GITHUB_OUTPUT | |
| - name: Parse Changelog | |
| id: changelog | |
| uses: mindsers/changelog-reader-action@v2 | |
| with: | |
| version: ${{ steps.metadata.outputs.version }} | |
| - name: Set up python 3.12 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.12 | |
| - name: Install build | |
| run: | | |
| pip install build | |
| - name: Build project | |
| run: | | |
| python3 -m build . | |
| - name: Publish to test pypi | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| repository-url: https://test.pypi.org/legacy/ | |
| attestations: false | |
| - name: Publish to pypi | |
| uses: pypa/gh-action-pypi-publish@release/v1 | |
| with: | |
| attestations: false | |
| - name: Create GitHub release | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| prerelease: ${{ steps.changelog.outputs.status == 'prereleased' }} | |
| draft: ${{ steps.changelog.outputs.status == 'unreleased' }} | |
| body: | | |
| ## Changelog | |
| ${{ steps.changelog.outputs.changes }} | |
| [See release on PyPi](${{ steps.metadata.outputs.link }}) |