DM-44635: Nicer GitHub integration config #1247
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: CI | |
"on": | |
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/**" | |
- "renovate/**" | |
- "tickets/**" | |
- "u/**" | |
tags: | |
- "*" | |
pull_request: {} | |
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/[email protected] | |
test: | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
strategy: | |
matrix: | |
python: | |
- "3.12" | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Run tox | |
uses: lsst-sqre/run-tox@v1 | |
with: | |
python-version: ${{ matrix.python }} | |
tox-envs: "py,coverage-report,typing" | |
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: > | |
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 }} | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Print GitHub event name | |
run: echo "${{ github.event_name }}" | |
- name: Filter paths | |
uses: dorny/paths-filter@v3 | |
id: filter | |
with: | |
filters: | | |
docs: | |
- "docs/**" | |
- "src/mobu/**" | |
docsSpecific: | |
- "docs/**" | |
- name: Install graphviz | |
if: steps.filter.outputs.docs == 'true' || github.event_name == 'workflow_dispatch' | |
run: sudo apt-get install graphviz | |
- name: Build docs | |
if: steps.filter.outputs.docs == 'true' || github.event_name == 'workflow_dispatch' | |
uses: lsst-sqre/run-tox@v1 | |
with: | |
python-version: "3.12" | |
tox-envs: docs | |
tox-plugins: tox-uv | |
cache-key-prefix: docs | |
# Upload docs: | |
# - on pushes to main if *any* documentation content might have changed | |
# - on workflow dispatches if any documentation content might have changed | |
# - on pushes to tickets/ branches if docs/ directory content changed | |
- name: Upload to LSST the Docs | |
uses: lsst-sqre/ltd-upload@v1 | |
with: | |
project: "mobu" | |
dir: "docs/_build/html" | |
username: ${{ secrets.LTD_USERNAME }} | |
password: ${{ secrets.LTD_PASSWORD }} | |
if: >- | |
(github.event_name == 'push' && github.ref_name == 'main' && steps.filter.outputs.docs == 'true') | |
|| (github.event_name == 'workflow_dispatch') | |
|| (github.event_name == 'pull_request' && startsWith(github.head_ref, 'tickets/') && steps.filter.outputs.docsSpecific == 'true') |