Skip to content

Feature/output yaml values #678

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ArBridgeman wants to merge 16 commits into
base: main
Choose a base branch
from
Draft

Feature/output yaml values #678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
9896641
Move workflows to be in features
ArBridgeman Jan 26, 2026
362906d
Move section to configuration
ArBridgeman Jan 26, 2026
1fadf2b
Add dependency for mermaid diagrams in sphinx
ArBridgeman Jan 27, 2026
da100a8
Update with a description & flowcharts
ArBridgeman Jan 27, 2026
b02eb60
Add changelog entry
ArBridgeman Jan 27, 2026
a5d7d3a
Fix typo
ArBridgeman Jan 27, 2026
495d927
Switch to gerund
ArBridgeman Jan 27, 2026
0817e5e
Part 1: Apply reviewer comments
ArBridgeman Jan 27, 2026
8fa498e
Part 2: Apply reviewer comments
ArBridgeman Jan 27, 2026
f4814ff
Part 3: Apply reviewer comments
ArBridgeman Jan 27, 2026
fbdb6fb
Merge branch 'main' into documentation/676_move_and_improve_workflows
ArBridgeman Jan 27, 2026
44fb79e
Switch to using yaml to output string and prevent 'on' from being con…
ArBridgeman Jan 27, 2026
93cb0bf
Format so empty fields left without null
ArBridgeman Jan 27, 2026
f14d9c1
Keep | lines instead of quoting instead
ArBridgeman Jan 27, 2026
13155da
Keep quoting versioned strings
ArBridgeman Jan 27, 2026
8fe80f2
Try with new workflow
ArBridgeman Jan 27, 2026
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
310 changes: 151 additions & 159 deletions .github/workflows/checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,197 +1,189 @@
name: Checks

on:
Copy link
Collaborator Author

@ArBridgeman ArBridgeman Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the extra whitespaces by default are gone. is it important to restore these?

workflow_call:

jobs:
Version-Check:
name: Version
runs-on: "ubuntu-24.04"
permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"

- name: Check Version(s)
run: poetry run -- nox -s version:check

- name: SCM Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"
- name: Check Version(s)
run: poetry run -- nox -s version:check
Documentation:
name: Docs
needs: [ Version-Check ]
needs:
- Version-Check
Copy link
Collaborator Author

@ArBridgeman ArBridgeman Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lists are broken into vertical splits

runs-on: "ubuntu-24.04"
permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"

- name: Build Documentation
run: |
poetry run -- nox -s docs:build

- name: Link Check
run: |
poetry run -- nox -s links:check

- name: SCM Checkout
uses: actions/checkout@v6
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"
- name: Build Documentation
run: |
Copy link
Collaborator Author

@ArBridgeman ArBridgeman Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could be updated in the template to be 1 line

poetry run -- nox -s docs:build
- name: Link Check
run: |
poetry run -- nox -s links:check
Changelog:
name: Changelog Update Check
runs-on: "ubuntu-24.04"
permissions:
contents: read
if: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/master' }}
steps:
- name: SCM Checkout
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"

- name: Run changelog update check
run: poetry run -- nox -s changelog:updated

- name: SCM Checkout
uses: actions/checkout@v6
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"
- name: Run changelog update check
run: poetry run -- nox -s changelog:updated
Lint:
name: Linting (Python-${{ matrix.python-versions }})
needs: [ Version-Check ]
needs:
- Version-Check
runs-on: "ubuntu-24.04"
permissions:
contents: read
strategy:
fail-fast: false
matrix:
python-versions: ["3.10", "3.11", "3.12", "3.13", "3.14"]
python-versions:
- "3.10"
- "3.11"
- "3.12"
- "3.13"
- "3.14"
steps:
- name: SCM Checkout
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"

- name: Run lint
run: poetry run -- nox -s lint:code

- name: Upload Artifacts
uses: actions/upload-artifact@v6
with:
name: lint-python${{ matrix.python-versions }}
path: |
.lint.txt
.lint.json
include-hidden-files: true

- name: SCM Checkout
uses: actions/checkout@v6
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"
- name: Run lint
run: poetry run -- nox -s lint:code
- name: Upload Artifacts
uses: actions/upload-artifact@v6
with:
name: lint-python${{ matrix.python-versions }}
path: |
.lint.txt
.lint.json
include-hidden-files: true
Type-Check:
name: Type Checking (Python-${{ matrix.python-versions }})
needs: [ Version-Check ]
needs:
- Version-Check
runs-on: "ubuntu-24.04"
permissions:
contents: read
strategy:
fail-fast: false
matrix:
python-versions: ["3.10", "3.11", "3.12", "3.13", "3.14"]

python-versions:
- "3.10"
- "3.11"
- "3.12"
- "3.13"
- "3.14"
steps:
- name: SCM Checkout
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"

- name: Run type-check
run: poetry run -- nox -s lint:typing

- name: SCM Checkout
uses: actions/checkout@v6
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"
- name: Run type-check
run: poetry run -- nox -s lint:typing
Security:
name: Security Checks (Python-${{ matrix.python-versions }})
needs: [ Version-Check ]
needs:
- Version-Check
runs-on: "ubuntu-24.04"
permissions:
contents: read
strategy:
fail-fast: false
matrix:
python-versions: ["3.10", "3.11", "3.12", "3.13", "3.14"]

python-versions:
- "3.10"
- "3.11"
- "3.12"
- "3.13"
- "3.14"
steps:
- name: SCM Checkout
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"

- name: Run security linter
run: poetry run -- nox -s lint:security

- name: Upload Artifacts
uses: actions/upload-artifact@v6
with:
name: security-python${{ matrix.python-versions }}
path: .security.json
include-hidden-files: true

- name: SCM Checkout
uses: actions/checkout@v6
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"
- name: Run security linter
run: poetry run -- nox -s lint:security
- name: Upload Artifacts
uses: actions/upload-artifact@v6
with:
name: security-python${{ matrix.python-versions }}
path: .security.json
include-hidden-files: true
Format:
name: Format Check
runs-on: "ubuntu-24.04"
permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"

- name: Run format check
run: poetry run -- nox -s format:check


- name: SCM Checkout
uses: actions/checkout@v6
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"
- name: Run format check
run: poetry run -- nox -s format:check
Build-Packages:
name: Build Package Check
needs: [ Documentation, Lint, Type-Check, Security, Format ]
needs:
- Documentation
- Lint
- Type-Check
- Security
- Format
runs-on: "ubuntu-24.04"
permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"

- name: Run Distribution Check
run: poetry run -- nox -s package:check

- name: SCM Checkout
uses: actions/checkout@v6
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"
- name: Run Distribution Check
run: poetry run -- nox -s package:check
Lint-Imports:
name: Lint Imports
runs-on: ubuntu-24.04
Expand All @@ -200,46 +192,46 @@ jobs:
steps:
- name: SCM Checkout
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: "3.10"
poetry-version: "2.3.0"

- name: Run import linter
run: poetry run -- nox -s lint:import

Tests:
name: Unit-Tests (Python-${{ matrix.python-versions }})
needs: [ Build-Packages, Lint-Imports ]
needs:
- Build-Packages
- Lint-Imports
runs-on: "ubuntu-24.04"
permissions:
contents: read
strategy:
fail-fast: false
matrix:
python-versions: ["3.10", "3.11", "3.12", "3.13", "3.14"]

python-versions:
- "3.10"
- "3.11"
- "3.12"
- "3.13"
- "3.14"
steps:
- name: SCM Checkout
uses: actions/checkout@v6
# The PTB has unit tests which require the fetch-depth to be 0.
with:
fetch-depth: 0

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"

- name: Run Tests and Collect Coverage
run: poetry run -- nox -s test:unit -- --coverage

- name: Upload Artifacts
uses: actions/upload-artifact@v6
with:
name: coverage-python${{ matrix.python-versions }}-fast
path: .coverage
include-hidden-files: true
- name: SCM Checkout
uses: actions/checkout@v6
# The PTB has unit tests which require the fetch-depth to be 0.
with:
fetch-depth: 0
- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
with:
python-version: ${{ matrix.python-versions }}
poetry-version: "2.3.0"
- name: Run Tests and Collect Coverage
run: poetry run -- nox -s test:unit -- --coverage
- name: Upload Artifacts
uses: actions/upload-artifact@v6
with:
name: coverage-python${{ matrix.python-versions }}-fast
path: .coverage
include-hidden-files: true
Binary file removed doc/_static/github-workflows.png
View file
Open in desktop
Binary file not shown.
Loading
Loading