Merge pull request #12 from lsst-sqre/r/012 #128
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 | |
| env: | |
| # Current supported Python version. For applications, there is generally no | |
| # reason to support multiple Python versions, so all actions are run with | |
| # this version. Quote the version to avoid interpretation as a floating | |
| # point number. | |
| PYTHON_VERSION: "3.12" | |
| "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/**" | |
| tags: | |
| - "*" | |
| 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: ${{ env.PYTHON_VERSION }} | |
| - name: Run pre-commit | |
| uses: pre-commit/action@v3.0.1 | |
| test: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Run tox | |
| uses: lsst-sqre/run-tox@v1 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| tox-envs: "py,coverage-report,typing" | |
| tox-requirements: requirements/tox.txt | |
| docs: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| # Ensure the documentation gets the right version. | |
| fetch-depth: 0 | |
| - uses: lsst-sqre/run-tox@v1 | |
| with: | |
| python-version: "3.12" | |
| tox-envs: docs | |
| tox-requirements: "requirements/tox.txt" | |
| cache-key-prefix: docs | |
| # Only attempt documentation uploads for long-lived branches, tagged | |
| # releases, and pull requests from ticket branches. This avoids version | |
| # clutter in the docs and failures when a PR doesn't have access to | |
| # secrets. | |
| - uses: lsst-sqre/ltd-upload@v1 | |
| with: | |
| project: ghostwriter | |
| dir: "docs/_build/html" | |
| username: ${{ secrets.LTD_USERNAME }} | |
| password: ${{ secrets.LTD_PASSWORD }} | |
| if: > | |
| github.event_name != 'merge_group' | |
| && (github.event_name != 'pull_request' | |
| || startsWith(github.head_ref, 'tickets/')) | |
| linkcheck: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Check links | |
| uses: lsst-sqre/run-tox@v1 | |
| with: | |
| python-version: "3.12" | |
| tox-envs: docs-linkcheck | |
| tox-requirements: "requirements/tox.txt" | |
| build: | |
| runs-on: ubuntu-latest | |
| needs: [lint, test] | |
| timeout-minutes: 10 | |
| # Only do Docker builds of tagged releases and pull requests from ticket | |
| # branches. This will still trigger on pull requests from untrusted | |
| # repositories whose branch names match our tickets/* branch convention, | |
| # but in this case the build will fail with an error since the secret | |
| # won't be set. | |
| if: > | |
| github.event_name != 'merge_group' | |
| && (startsWith(github.ref, 'refs/tags/') | |
| || startsWith(github.head_ref, 'tickets/')) | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: lsst-sqre/build-and-push-to-ghcr@v1 | |
| id: build | |
| with: | |
| image: ${{ github.repository }} | |
| github_token: ${{ secrets.GITHUB_TOKEN }} |