Skip to content

Security/update dependencies and switch gh pages #104

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

Merged
ArBridgeman merged 11 commits into from
Jun 27, 2025
Merged

Security/update dependencies and switch gh pages #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6b1ad74
Relock dependencies to resolve vulnerabilities for urllib3 and requests
ArBridgeman Jun 25, 2025
0bb5e36
Update python-toolbox to 1.5.0 and its related workflows
ArBridgeman Jun 25, 2025
411e8ae
Project fix
ArBridgeman Jun 26, 2025
7c5d8eb
Add sonar project and values to pyproject.toml
ArBridgeman Jun 26, 2025
6ca180c
Remove ignores that pass checks
ArBridgeman Jun 26, 2025
ba1535b
Fix missed python toolbox updates
ArBridgeman Jun 26, 2025
64ced53
Fix missed python toolbox updates
ArBridgeman Jun 26, 2025
abc410a
Generate openapi models
ArBridgeman Jun 26, 2025
68c0ea0
Add inherit secrets for sonar to ci.yml
ArBridgeman Jun 26, 2025
c285e72
Ignore generated api code
ArBridgeman Jun 26, 2025
06a1917
Remove sonar for now as need to look into how to ignore generated files
ArBridgeman Jun 26, 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
5 changes: 3 additions & 2 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,13 +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
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0

- name: Build Artifacts
run: poetry build
Expand Down
9 changes: 8 additions & 1 deletion .github/workflows/cd.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +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
5 changes: 4 additions & 1 deletion .github/workflows/check-api-outdated.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ jobs:
check-api-outdated:
name: Check API Outdated
runs-on: ubuntu-24.04
permissions:
contents: read
actions: read
strategy:
fail-fast: false

Expand All @@ -26,7 +29,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.5.0
with:
python-version: "3.10"

Expand Down
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.5.0

- name: Check Tag Version
# make sure the pushed/created tag matched the project version
Expand Down
44 changes: 28 additions & 16 deletions .github/workflows/checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,34 +4,35 @@ 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.5.0

- name: Check Version(s)
run: poetry run -- version-check version.py
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.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0

- name: Build Documentation
run: |
Expand All @@ -40,18 +41,21 @@ jobs:
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.5.0

- name: Run changelog update check
run: poetry run -- nox -s changelog:updated
Expand All @@ -60,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.5.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 @@ -89,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 @@ -98,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.5.0
with:
python-version: ${{ matrix.python-version }}

Expand All @@ -109,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 @@ -118,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.5.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 @@ -135,13 +144,14 @@ 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.5.0

- name: Run format check
run: poetry run -- nox -s project:format
Expand All @@ -154,5 +164,7 @@ jobs:
matrix: ${{ fromJson(needs.build-matrix.outputs.matrix) }}
uses: ./.github/workflows/run-tests.yml
secrets: inherit
permissions:
contents: read
with:
python-version: ${{ matrix.python-version }}
24 changes: 18 additions & 6 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,43 @@
name: CI

on:
push:
branches-ignore:
- "github-pages/*"
- "gh-pages/*"
- "main"
- "master"
pull_request:
types: [opened, synchronize, reopened]
schedule:
# At 00:00 on every 7th day-of-month from 1 through 31. (https://crontab.guru)
- cron: "0 0 1/7 * *"

jobs:

ci-job:
name: Checks
uses: ./.github/workflows/checks.yml
secrets: inherit
permissions:
contents: read

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

gate-1:
name: Gate 1 - Regular CI
needs: [ ci-job ]
runs-on: ubuntu-24.04
permissions:
contents: read
steps:
- name: Branch Protection
run: true

slow-test-detection:
name: Run Slow or Expensive Tests (e.g. SaaS)?
runs-on: ubuntu-24.04
permissions:
contents: read
steps:
- name: Detect Slow Tests
run: true
Expand All @@ -41,6 +49,8 @@ jobs:
uses: ./.github/workflows/run-tests.yml
needs: [ slow-test-detection ]
secrets: inherit
permissions:
contents: read
with:
slow-tests: true
python-version: "3.10"
Expand All @@ -49,6 +59,8 @@ jobs:
name: Gate 2 - Allow Merge
runs-on: ubuntu-24.04
needs: [ run-slow-tests ]
permissions:
contents: read
steps:
- name: Branch Protection
run: true
32 changes: 23 additions & 9 deletions .github/workflows/gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,40 @@ on:

jobs:

documentation-job:
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.0.1
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0

- name: Build Documentation
run: |
poetry run -- nox -s docs:multiversion
rm -r .html-documentation/*/.doctrees

- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4.7.2
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
branch: gh-pages
folder: .html-documentation
git-config-name: Github Action
git-config-email: opensource@exasol.com
path: .html-documentation

deploy-documentation:
Copy link
Copy Markdown
Contributor Author

@ArBridgeman ArBridgeman Jun 26, 2025

Choose a reason for hiding this comment

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

need to update settings

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.5.0

- name: Generate matrix
run: poetry run -- nox -s matrix:python
Expand Down
Loading