Skip to content

[WIP] Update Lightning Integration Tests #90

[WIP] Update Lightning Integration Tests

[WIP] Update Lightning Integration Tests #90

Workflow file for this run

name: Docs
on:
push:
branches: ["main"]
pull_request:
types: [opened, reopened, ready_for_review, synchronize]
jobs:
docs-build:
runs-on: ubuntu-latest
if: github.event.pull_request.draft == false
timeout-minutes: 10
steps:
- uses: actions/checkout@v5
- name: Install uv and setup python
uses: astral-sh/setup-uv@v6
with:
activate-environment: true
python-version: "3.12"
enable-cache: true
- name: Install package & doc dependencies
run: |
uv sync --group docs
uv pip list
- name: Build docs
working-directory: docs/source
run: |
make html SPHINXOPTS="-W --keep-going"
- name: Upload docs artifact
if: github.event_name == 'pull_request'
uses: actions/upload-artifact@v4
with:
name: docs-build
path: docs/build/html/
retention-days: 7
docs-linkcheck:
runs-on: ubuntu-latest
if: github.event.pull_request.draft == false
timeout-minutes: 10
steps:
- uses: actions/checkout@v5
- name: Install uv and setup python
uses: astral-sh/setup-uv@v6
with:
activate-environment: true
python-version: "3.12"
enable-cache: true
- name: Install package & doc dependencies
run: |
uv sync --group docs
uv pip list
- name: Check links
working-directory: docs/source
run: |
make linkcheck
docs-doctest:
runs-on: ubuntu-latest
if: github.event.pull_request.draft == false
timeout-minutes: 10
steps:
- uses: actions/checkout@v5
- name: Install uv and setup python
uses: astral-sh/setup-uv@v6
with:
activate-environment: true
python-version: "3.12"
enable-cache: true
- name: Install package & doc dependencies
run: |
uv sync --group docs
uv pip list
- name: Run doctests
working-directory: docs/source
run: |
make doctest
guardian-docs:
runs-on: ubuntu-latest
needs: [docs-build, docs-linkcheck, docs-doctest]
if: always()
steps:
- run: |
echo "build: ${{ needs.docs-build.result }}"
echo "linkcheck: ${{ needs.docs-linkcheck.result }}"
echo "doctest: ${{ needs.docs-doctest.result }}"
- name: failing...
if: |
needs.docs-build.result == 'failure' ||
needs.docs-linkcheck.result == 'failure' ||
needs.docs-doctest.result == 'failure'
run: exit 1
- name: cancelled or skipped...
if: |
contains(fromJSON('["cancelled", "skipped"]'), needs.docs-build.result) ||
contains(fromJSON('["cancelled", "skipped"]'), needs.docs-linkcheck.result) ||
contains(fromJSON('["cancelled", "skipped"]'), needs.docs-doctest.result)
timeout-minutes: 1
run: sleep 90