Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/build-and-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
contents: write
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/check-release-tag.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand Down
26 changes: 13 additions & 13 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6
with:
fetch-depth: 0

Expand All @@ -29,7 +29,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -56,7 +56,7 @@ jobs:
if: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/master' }}
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -75,7 +75,7 @@ jobs:
matrix: ${{ fromJson(needs.build-matrix.outputs.matrix) }}
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -86,7 +86,7 @@ jobs:
run: poetry run -- nox -s lint:code

- name: Upload Artifacts
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v6
with:
name: lint-python${{ matrix.python-version }}
path: |
Expand All @@ -106,7 +106,7 @@ jobs:

steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -128,7 +128,7 @@ jobs:

steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -139,7 +139,7 @@ jobs:
run: poetry run -- nox -s lint:security

- name: Upload Artifacts
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v6
with:
name: security-python${{ matrix.python-version }}
path: .security.json
Expand All @@ -152,7 +152,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -168,7 +168,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -183,7 +183,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -203,7 +203,7 @@ jobs:

steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6
# The PTB has unit tests which require the fetch-depth to be 0.
with:
fetch-depth: 0
Expand All @@ -217,7 +217,7 @@ jobs:
run: poetry run -- nox -s test:unit -- --coverage

- name: Upload Artifacts
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v6
with:
name: coverage-python${{ matrix.python-version }}-fast
path: .coverage
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6
with:
fetch-depth: 0

Expand All @@ -22,12 +22,12 @@ jobs:
- name: Build Documentation
run: |
poetry run -- nox -s docs:multiversion
rm -r .html-documentation/*/.doctrees
mv .html-documentation html-documentation
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
uses: actions/upload-pages-artifact@v4
with:
path: .html-documentation
path: html-documentation

deploy-documentation:
needs: [ build-documentation ]
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/matrix-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/matrix-exasol.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/matrix-python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ jobs:

steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6
with:
fetch-depth: 0

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment

- name: Download Artifacts
uses: actions/download-artifact@v6
uses: actions/download-artifact@v7
with:
path: ./artifacts

Expand All @@ -41,7 +41,7 @@ jobs:
run: poetry run -- nox -s project:report -- --format json | tee metrics.json

- name: Upload Artifacts
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v6
with:
name: metrics.json
path: metrics.json
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/slow-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:

steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand All @@ -35,7 +35,7 @@ jobs:
run: poetry run -- nox -s test:integration -- --coverage --db-version ${{ matrix.exasol-version }}

- name: Upload Artifacts
uses: actions/upload-artifact@v5
uses: actions/upload-artifact@v6
with:
name: coverage-python${{ matrix.python-version }}-slow
path: .coverage
Expand All @@ -62,7 +62,7 @@ jobs:

steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Set up Python & Poetry Environment
uses: ./.github/actions/python-environment
Expand Down
38 changes: 34 additions & 4 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,34 @@

## Summary

In exasol-toolbox version `5.0.0` and higher the default behavior for
`.github/actions/python-environment/action.yml` has changed. In previous versions,
the default value for `poetry-version` was `2.1.2`, and it is now `2.3.0`.
In this major release, attention needs to be given to the following:

* `gh-pages.yml` changes
* See GitHub `upload-pages-artifact` v4
* default Poetry version changed from `2.1.2` to `2.3.0`
* See Poetry Update

### GitHub `upload-pages-artifact` v4

In v4, the developers of `upload-pages-artifact` dropped support for uploading
dotfiles. This means that the `gh-pages.yml` has been modified such that it
converts the generated `.html-documentation` to `html-documentation`. It was also checked
which files are created by the nox session `docs:build`. It was found that in many cases
that the only dotfiles produced are `.buildinfo` and `.doctrees`, which do not need
to be uploaded for the GitHub pages to work. To verify that your project will not be
adversely affected by these changes, please:

1. Run the nox sessions `docs:build`
2. Use this command to see what dotfiles are created:
```bash
ls -a .hmtl-documentation/ | grep "^\."
```
3. If there are other critical dotfiles, consider converting them. Otherwise, create
an issue in the `python-toolbox`.

### Poetry Update
The default behavior for `.github/actions/python-environment/action.yml` has changed.
In previous versions, the default value for `poetry-version` was `2.1.2`, and it is now `2.3.0`.

* Depending on its poetry version, a repository relying on the default behavior of said
action may run into breaking changes. This can easily be resolved with explicitly setting the
Expand Down Expand Up @@ -42,4 +67,9 @@ take care and will need to make manual changes to ensure it still works with

## Refactoring

* 624: Updated GitHub python-environment action and all code to use Poetry >= 2.3.0
* #624: Updated GitHub python-environment action and all code to use Poetry >= 2.3.0
* #662: Update GitHub actions
* `checkout` from v5 to [v6](https://github.com/actions/checkout/releases/tag/v6.0.0) - using Node.js 24
* `upload-pages-artifact` from v3 to [v4](https://github.com/actions/upload-pages-artifact/releases/tag/v4.0.0) - breaking change
* `download-artifact`from v6 to [v7](https://github.com/actions/download-artifact/releases/tag/v7.0.0) - using Node.js 24
* `upload-artifact` from v5 to [v6](https://github.com/actions/upload-artifact/releases/tag/v6.0.0) - using Node.js 24
4 changes: 2 additions & 2 deletions doc/github_actions/python_environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ Example Usage
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6
- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@v1
uses: exasol/python-toolbox/.github/actions/python-environment@v4
with:
python-version: 3.12
poetry-version: 2.3.0
Expand Down
2 changes: 1 addition & 1 deletion doc/github_actions/security_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Example Usage
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6
- name: Report Security Issues
uses: exasol/python-toolbox/.github/actions/security-issues@v1
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
contents: write
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@v4
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
contents: read
steps:
- name: SCM Checkout
uses: actions/checkout@v5
uses: actions/checkout@v6

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@v4
Expand Down
Loading