Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added .circleci/config.yml
Empty file.
3 changes: 2 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,6 @@ updates:
schedule:
interval: weekly
ignore:
- dependency-name: ruff
- dependency-name: bandit
- dependency-name: ruff
- dependency-name: sphinx-lint
48 changes: 31 additions & 17 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@ on:

permissions: read-all

env:
CACHE_GLOBS: |
**/pyproject.toml
**/requirements*.txt
**/setup.py
**/uv.lock
ENDPOINT_WHITELIST: >-
pypi.org:443
github.com:443
releases.astral.sh
files.pythonhosted.org:443
*.github.com:443
*.githubusercontent.com:443

jobs:
build:
runs-on: ubuntu-latest
Expand All @@ -19,26 +33,24 @@ jobs:
with:
disable-sudo: true
egress-policy: block
allowed-endpoints: >
files.pythonhosted.org:443
github.com:443
pypi.org:443
allowed-endpoints: ${{ env.ENDPOINT_WHITELIST}}

- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
with:
# If it's a push (main or major-release) or workflow_dispatch, get full history.
fetch-depth: ${{ (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && 0 || 1 }}
# If it's a pull request, don't get full history.
fetch-depth: ${{ github.event_name == 'pull_request' && 1 || 0 }}

- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
- uses: astral-sh/setup-uv@5a095e7a2014a4212f075830d4f7277575a9d098
with:
python-version: '3.13'
cache: pip

- uses: install-pinned/uv@259f91feb61b6e94766d7a1dbcd5f17335370e64
python-version: 3.13
activate-environment: true
cache-dependency-glob: ${{ env.CACHE_GLOBS }}

- run: |
uv pip install --system -e .[all]
uv pip install --system -r requirements-dev.txt
- run: >-
uv sync
--upgrade
--no-default-groups
--group docs

- name: configure git
run: |
Expand All @@ -49,6 +61,7 @@ jobs:
with:
path: docs/html
key: >-
uv run
sphinx
-${{ hashFiles('pyproject.toml') }}
-${{ hashFiles('setup.py') }}
Expand All @@ -65,8 +78,8 @@ jobs:

deploy:
needs: build
# Only run this job if triggered by updating the main branch
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
# Don't run this job on pull requests
if: github.event_name != 'pull_request'

runs-on: ubuntu-latest

Expand All @@ -82,6 +95,7 @@ jobs:
- uses: step-security/harden-runner@e3f713f2d8f53843e71c69a996d56f51aa9adfb9
with:
disable-sudo: true
egress-policy: audit
egress-policy: block
allowed-endpoints: ${{ env.ENDPOINT_WHITELIST}}

- uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e
Loading
Loading