#dm-docs-support -> #square-docs-support
#354
Workflow file for this run
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: Python CI | |
| "on": | |
| merge_group: {} | |
| pull_request: {} | |
| push: | |
| branches-ignore: | |
| # These should always correspond to pull requests, so ignore them for | |
| # the push trigger and let them be triggered by the pull_request | |
| # trigger, avoiding running the workflow twice. This is a minor | |
| # optimization so there's no need to ensure this is comprehensive. | |
| - "dependabot/**" | |
| - "gh-readonly-queue/**" | |
| - "renovate/**" | |
| - "tickets/**" | |
| - "u/**" | |
| release: | |
| types: [published] | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: Run pre-commit | |
| uses: pre-commit/action@v3.0.1 | |
| test: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| strategy: | |
| matrix: | |
| python: | |
| - "3.8" | |
| - "3.9" | |
| - "3.10" | |
| - "3.11" | |
| - "3.12" | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Run tox | |
| uses: lsst-sqre/run-tox@v1 | |
| with: | |
| python-version: ${{ matrix.python }} | |
| tox-envs: "py,typing" | |
| env: | |
| LTD_TEST_AWS_ID: ${{ secrets.LTD_TEST_AWS_ID }} | |
| LTD_TEST_AWS_SECRET: ${{ secrets.LTD_TEST_AWS_SECRET }} | |
| LTD_TEST_BUCKET: ${{ secrets.LTD_TEST_BUCKET }} | |
| docs: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # full history for setuptools_scm | |
| - name: Install Graphviz | |
| run: sudo apt-get install graphviz | |
| - name: Run tox | |
| uses: lsst-sqre/run-tox@v1 | |
| with: | |
| python-version: "3.12" | |
| tox-envs: "docs" | |
| # Add docs-linkcheck when the docs and PyPI package are published | |
| # tox-envs: "docs,docs-linkcheck" | |
| # Use LTD Conveyor from the repo to dogfood it. | |
| - name: "Install LTD Conveyor from repo" | |
| run: pip install . | |
| # Only attempt documentation uploads for tagged releases and pull | |
| # requests from ticket branches in the same repository. This avoids | |
| # version clutter in the docs and failures when a PR doesn't have access | |
| # to secrets. | |
| - name: Upload to LSST the Docs | |
| run: ltd upload --dir docs/_build/html --product ltd-conveyor --gh | |
| env: | |
| LTD_USERNAME: ${{ secrets.LTD_USERNAME }} | |
| LTD_PASSWORD: ${{ secrets.LTD_PASSWORD }} | |
| if: > | |
| github.event_name != 'merge_group' | |
| && (github.event_name != 'pull_request' | |
| || startsWith(github.head_ref, 'tickets/')) | |
| test-packaging: | |
| name: Test packaging | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # full history for setuptools_scm | |
| - name: Build and publish | |
| uses: lsst-sqre/build-and-publish-to-pypi@v2 | |
| with: | |
| python-version: "3.12" | |
| upload: false | |
| pypi: | |
| # This job requires set up: | |
| # 1. Set up a trusted publisher for PyPI | |
| # 2. Set up a "pypi" environment in the repository | |
| # See https://github.com/lsst-sqre/build-and-publish-to-pypi | |
| name: Upload release to PyPI | |
| runs-on: ubuntu-latest | |
| needs: [lint, test, docs, test-packaging] | |
| environment: | |
| name: pypi | |
| url: https://pypi.org/p/ltd-conveyor | |
| permissions: | |
| id-token: write | |
| if: github.event_name == 'release' && github.event.action == 'published' | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 # full history for setuptools_scm | |
| - name: Build and publish | |
| uses: lsst-sqre/build-and-publish-to-pypi@v2 | |
| with: | |
| python-version: "3.12" |