Skip to content

Security/update dependencies and switch gh pages #70

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 7 commits into from
Jun 25, 2025
Merged

Security/update dependencies and switch gh pages #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
07ca8cd
Update transitive dependencies for urllib3 and requests vulnerabilities
ArBridgeman Jun 25, 2025
01b780a
Remove non-ASCII Unicodes in issue / PR templates
ArBridgeman Jun 25, 2025
5ae96e4
Update python-toolbox to 1.5.0 and its related workflows
ArBridgeman Jun 25, 2025
9961511
Add sources & python_versions for sonar
ArBridgeman Jun 25, 2025
784f614
Fix project formatting
ArBridgeman Jun 25, 2025
66260c8
Add sonar project and values to pyproject.toml
ArBridgeman Jun 25, 2025
7077172
Replace constructor with literal
ArBridgeman Jun 25, 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
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/blank.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: 📝 Blank Issue
name: Blank Issue
about: Blank Issue
title: 📝 <Insert Title>
title: <Insert Title>
labels:
assignees: ''

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: 🐞 Bug Report
name: Bug Report
about: File a bug report
title: 🐞 <Insert Title>
title: <Insert Title>
labels: bug
assignees: ''

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: 📚 Documentation
name: Documentation
about: Add/Improve Documentation
title: 📚 <Insert Title>
title: <Insert Title>
labels: documentation
assignees: ''

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: ✨ Feature
name: Feature
about: Add/Implement Feature
title: ✨ <Insert Title>
title: <Insert Title>
labels: feature
assignees: ''

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/refactoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: 🔧 Refactoring
name: Refactoring
about: Refactor
title: 🔧 <Insert Title>
title: <Insert Title>
labels: refactoring
assignees: ''

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: 🔐 Security Issue
name: Security Issue
about: Fix Security Issue
title: 🔐 <Insert Title>
title: <Insert Title>
labels: security
assignees: ''

Expand Down
7 changes: 3 additions & 4 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,15 +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.1.0
with:
poetry-version: '2.1.2'
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0

- name: Build Artifacts
run: poetry build
Expand Down
8 changes: 8 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,15 +10,23 @@ 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

11 changes: 5 additions & 6 deletions .github/workflows/check-release-tag.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +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.1.0
with:
poetry-version: '2.1.2'
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
55 changes: 27 additions & 28 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,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.1.0
with:
poetry-version: '2.1.2'
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0

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

- name: Build Documentation
run: |
Expand All @@ -45,20 +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.1.0
with:
poetry-version: '2.1.2'
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 @@ -67,19 +64,19 @@ 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.1.0
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0
with:
python-version: ${{ matrix.python-version }}
poetry-version: '2.1.2'

- name: Run lint
run: poetry run -- nox -s lint:code
Expand All @@ -97,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 @@ -106,10 +105,9 @@ jobs:
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.1.0
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0
with:
python-version: ${{ matrix.python-version }}
poetry-version: '2.1.2'

- name: Run type-check
run: poetry run -- nox -s lint:typing
Expand All @@ -118,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 @@ -127,10 +127,9 @@ jobs:
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.1.0
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0
with:
python-version: ${{ matrix.python-version }}
poetry-version: '2.1.2'

- name: Run security linter
run: poetry run -- nox -s lint:security
Expand All @@ -145,15 +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.1.0
with:
poetry-version: '2.1.2'
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0

- name: Run format check
run: poetry run -- nox -s project:format
Expand All @@ -162,6 +160,8 @@ jobs:
name: Unit-Tests (Python-${{ matrix.python-version }})
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 @@ -173,10 +173,9 @@ jobs:
uses: actions/checkout@v4

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@1.1.0
uses: exasol/python-toolbox/.github/actions/python-environment@1.5.0
with:
python-version: ${{ matrix.python-version }}
poetry-version: '2.1.2'

- name: Run Tests and Collect Coverage
run: poetry run -- nox -s test:unit -- --coverage
Expand Down
15 changes: 8 additions & 7 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
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)
# 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
secrets: inherit
permissions:
contents: read
34 changes: 23 additions & 11 deletions .github/workflows/gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +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.1.0
with:
poetry-version: '2.1.2'
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.3
- 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
Collaborator Author

@ArBridgeman ArBridgeman Jun 25, 2025

Choose a reason for hiding this comment

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

I updated the settings for these changes

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
Loading