Skip to content

Fix docs mentioning date_modified #179

Fix docs mentioning date_modified

Fix docs mentioning date_modified #179

Workflow file for this run

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
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Run pre-commit
uses: pre-commit/action@v3.0.0
test:
runs-on: ubuntu-latest
strategy:
matrix:
python:
- '3.11'
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
cache: 'npm'
node-version-file: '.nvmrc'
- name: npm install and build
run: |
npm install
npm run build
- name: Run tox
uses: lsst-sqre/run-tox@v1
with:
python-version: ${{ matrix.python }}
tox-envs: 'py,typing'
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # full history for setuptools_scm
- name: Install Graphviz
run: sudo apt-get install graphviz
- uses: actions/setup-node@v4
with:
cache: 'npm'
node-version-file: '.nvmrc'
- name: npm install and build
run: |
npm install
npm run build
- name: Run tox
uses: lsst-sqre/run-tox@v1
with:
python-version: '3.11'
tox-envs: 'demo,docs'
# tox-envs: "docs,docs-linkcheck"
# 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
uses: lsst-sqre/ltd-upload@v1
with:
project: 'technote'
dir: 'docs/_build/html'
username: ${{ secrets.LTD_USERNAME }}
password: ${{ secrets.LTD_PASSWORD }}
if: >
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.11'
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/technote
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
- uses: actions/setup-node@v4
with:
cache: 'npm'
node-version-file: '.nvmrc'
- name: npm install and build
run: |
npm install
npm run build
- name: Build and publish
uses: lsst-sqre/build-and-publish-to-pypi@v2
with:
python-version: '3.11'