Skip to content

#301: Update PTB and workflows and activate generation of GH pages #302

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

#301: Update PTB and workflows and activate generation of GH pages #302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0569682
#301: Update PTB and workflows and activate generation of GH pages
tomuben Jun 16, 2025
4323683
Updated changelog
tomuben Jun 16, 2025
d7800dc
Debug
tomuben Jun 16, 2025
f0f17c7
Debug
tomuben Jun 16, 2025
2d4a593
Debug
tomuben Jun 16, 2025
cc1d1e0
Debug
tomuben Jun 16, 2025
2617fe4
Debug
tomuben Jun 16, 2025
8f99d31
Fixes from review
tomuben Jun 16, 2025
fa52212
Fixes from review
tomuben Jun 16, 2025
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
8 changes: 3 additions & 5 deletions .github/workflows/build-and-publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,14 @@ jobs:
cd-job:
name: Continuous Delivery
runs-on: ubuntu-24.04
permissions:
contents: write
steps:

- name: SCM Checkout
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
with:
python-version: '3.10'
poetry-version: '2.1.2'
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

- name: Build Artifacts
run: poetry build
Expand Down
13 changes: 13 additions & 0 deletions .github/workflows/cd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,22 @@ jobs:
check-tag-version-job:
name: Check Release Tag
uses: ./.github/workflows/check-release-tag.yml
permissions:
contents: read

cd-job:
name: Continuous Delivery
uses: ./.github/workflows/build-and-publish.yml
permissions:
contents: write
secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}

publish-docs:
needs: [ cd-job ]
name: Publish Documentation
uses: ./.github/workflows/gh-pages.yml
permissions:
contents: read
pages: write
id-token: write
9 changes: 5 additions & 4 deletions .github/workflows/check-release-tag.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
name: Check Release Tag

on: workflow_call
on:
workflow_call:

jobs:

check-tag-version-job:

name: Check Tag Version
runs-on: ubuntu-24.04

permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

- name: Check Tag Version
# make sure the pushed/created tag matched the project version
Expand Down
61 changes: 44 additions & 17 deletions .github/workflows/checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,58 @@ on:
workflow_call:

jobs:

Version-Check:
name: Version
runs-on: ubuntu-24.04

permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

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

Documentation:
name: Docs
needs: [ Version-Check ]
runs-on: ubuntu-24.04
permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

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

build-matrix:
name: Generate Build Matrix
uses: ./.github/workflows/matrix-python.yml
permissions:
contents: read

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@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

- name: Run changelog update check
run: poetry run -- nox -s changelog:updated
Expand All @@ -45,24 +64,25 @@ jobs:
name: Linting (Python-${{ matrix.python-version }})
needs: [ Version-Check, build-matrix ]
runs-on: ubuntu-24.04
permissions:
contents: read
strategy:
fail-fast: false
matrix: ${{ fromJson(needs.build-matrix.outputs.matrix) }}

steps:
- name: SCM Checkout
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0
with:
python-version: ${{ matrix.python-version }}

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

- name: Upload Artifacts
uses: actions/upload-artifact@v4.6.0
uses: actions/upload-artifact@v4.6.2
with:
name: lint-python${{ matrix.python-version }}
path: |
Expand All @@ -74,6 +94,8 @@ jobs:
name: Type Checking (Python-${{ matrix.python-version }})
needs: [ Version-Check, build-matrix ]
runs-on: ubuntu-24.04
permissions:
contents: read
strategy:
fail-fast: false
matrix: ${{ fromJson(needs.build-matrix.outputs.matrix) }}
Expand All @@ -83,7 +105,7 @@ jobs:
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0
with:
python-version: ${{ matrix.python-version }}

Expand All @@ -94,6 +116,8 @@ jobs:
name: Security Checks (Python-${{ matrix.python-version }})
needs: [ Version-Check, build-matrix ]
runs-on: ubuntu-24.04
permissions:
contents: read
strategy:
fail-fast: false
matrix: ${{ fromJson(needs.build-matrix.outputs.matrix) }}
Expand All @@ -103,15 +127,15 @@ jobs:
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0
with:
python-version: ${{ matrix.python-version }}

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

- name: Upload Artifacts
uses: actions/upload-artifact@v4.6.0
uses: actions/upload-artifact@v4.6.2
with:
name: security-python${{ matrix.python-version }}
path: .security.json
Expand All @@ -120,21 +144,24 @@ jobs:
Format:
name: Format Check
runs-on: ubuntu-24.04

permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

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

Tests:
name: Unit-Tests (Python-${{ matrix.python-version }})
needs: [ Lint, Type-Check, Security, Format, build-matrix ]
needs: [ Documentation, Lint, Type-Check, Security, Format, build-matrix ]
runs-on: ubuntu-24.04
permissions:
contents: read
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
strategy:
Expand All @@ -146,15 +173,15 @@ jobs:
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0
with:
python-version: ${{ matrix.python-version }}

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

- name: Upload Artifacts
uses: actions/upload-artifact@v4.6.0
uses: actions/upload-artifact@v4.6.2
with:
name: coverage-python${{ matrix.python-version }}-fast
path: .coverage
Expand Down
9 changes: 8 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,16 @@ on:
schedule:
# “At 00:00 on every 7th day-of-month from 1 through 31.” (https://crontab.guru)
- cron: "0 0 1/7 * *"

jobs:

CI:
uses: ./.github/workflows/merge-gate.yml
secrets: inherit
permissions:
contents: read

Metrics:
needs: [ CI ]
uses: ./.github/workflows/report.yml
permissions:
contents: read
45 changes: 45 additions & 0 deletions .github/workflows/gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Publish Documentation

on:
workflow_call:
workflow_dispatch:

jobs:

build-documentation:
runs-on: ubuntu-24.04
permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

- name: Build Documentation
Copy link

@ArBridgeman ArBridgeman Jun 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

You did the needed actions in Settings?

Copy link

Choose a reason for hiding this comment

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

Sorry, I could have been more specific. For using this GitHub action & deploying the documentation, you'll need to follow these steps: https://github.com/exasol/python-toolbox/blob/main/doc/user_guide/getting_started.rst?plain=1#L182 . I was confirming if you had, as I don't have permissions to double-check it myself 😄

run: |
poetry run -- nox -s docs:multiversion
Copy link

Choose a reason for hiding this comment

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

Locally, this command fails for me poetry run -- nox -s docs:multiversion with ERROR ERROR:exasol.toolbox.sphinx.multiversion.main:No matching refs found!.
(but poetry run -- nox -s docs:build, which runs in the PR #checks.yml is ok). I haven't set up documentation for the PTB yet, but I think, as I didn't see the issue in the docs, that this is not an expected error.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I investigated the error. I think the error is caused by the fact that doc/conf.py is not yet part of any tag or the main branch.
tbx multiversion filters by this file here

Copy link

Choose a reason for hiding this comment

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

Yes, I think you're right. 😅

rm -r .html-documentation/*/.doctrees

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: .html-documentation

deploy-documentation:
needs: [ build-documentation ]
permissions:
contents: read
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-24.04
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
6 changes: 3 additions & 3 deletions .github/workflows/matrix-python.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ on:

jobs:
python_versions:

runs-on: ubuntu-24.04

permissions:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.4.0

- name: Generate matrix
run: poetry run -- nox -s matrix:python
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/merge-gate.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,22 @@ jobs:
fast-checks:
name: Fast
uses: ./.github/workflows/checks.yml
permissions:
contents: read

slow-checks:
name: Slow
uses: ./.github/workflows/slow-checks.yml
secrets: inherit
permissions:
contents: read

# This job ensures inputs have been executed successfully.
approve-merge:
name: Allow Merge
runs-on: ubuntu-24.04
permissions:
contents: read
# If you need additional jobs to be part of the merge gate, add them below
needs: [ fast-checks, slow-checks ]

Expand Down
17 changes: 16 additions & 1 deletion .github/workflows/pr-merge.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,19 @@ jobs:
ci-job:
name: Checks
uses: ./.github/workflows/checks.yml
secrets: inherit
permissions:
contents: read

publish-docs:
name: Publish Documentation
uses: ./.github/workflows/gh-pages.yml
permissions:
contents: read
pages: write
id-token: write

metrics:
needs: [ ci-job ]
uses: ./.github/workflows/report.yml
permissions:
contents: read
Loading
Loading