From 50d4f437f776a078f748c1ed551959caa535bd57 Mon Sep 17 00:00:00 2001 From: Nicola Coretti Date: Tue, 17 Dec 2024 09:41:46 +0100 Subject: [PATCH] Prepare release 0.20.0 (#316) --- doc/changes/changelog.md | 2 + doc/changes/changes_0.20.0.md | 49 +++++++++++++++++++ doc/changes/unreleased.md | 48 ------------------ .../github/workflows/build-and-publish.yml | 2 +- .../github/workflows/check-release-tag.yml | 2 +- .../templates/github/workflows/checks.yml | 14 +++--- .../templates/github/workflows/gh-pages.yml | 2 +- .../templates/github/workflows/matrix-all.yml | 2 +- .../github/workflows/matrix-exasol.yml | 2 +- .../github/workflows/matrix-python.yml | 2 +- .../templates/github/workflows/report.yml | 2 +- .../github/workflows/slow-checks.yml | 2 +- exasol/toolbox/version.py | 2 +- pyproject.toml | 2 +- 14 files changed, 68 insertions(+), 65 deletions(-) create mode 100644 doc/changes/changes_0.20.0.md diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md index a360fbc44..532244743 100644 --- a/doc/changes/changelog.md +++ b/doc/changes/changelog.md @@ -1,6 +1,7 @@ # Changelog * [unreleased](unreleased.md) +* [0.20.0](changes_0.20.0.md) * [0.19.0](changes_0.19.0.md) * [0.18.0](changes_0.18.0.md) * [0.17.0](changes_0.17.0.md) @@ -28,6 +29,7 @@ hidden: --- unreleased +changes_0.20.0 changes_0.19.0 changes_0.18.0 changes_0.17.0 diff --git a/doc/changes/changes_0.20.0.md b/doc/changes/changes_0.20.0.md new file mode 100644 index 000000000..26cbe8587 --- /dev/null +++ b/doc/changes/changes_0.20.0.md @@ -0,0 +1,49 @@ +# 0.20.0 - 2024-12-17 + +## 🚨 Breaking Changes +* **Matrices in CI/CD workflows will be generated automatically now** + + Make sure you have installed all the latest workflow files, especially the newly added ones: + + - `matrix-all.yml` + - `matrix-python.yml` + - `matrix-exasol.yml` + + +## ✨ Added +* Added support for dynamically generated workflow matrices. + + This feature allows you to easily change the test matrices in one place: `noxconfig.py`. + + Note: As usual, there are different ways a user can adjust or change the behavior. In the case of the build matrices, there are three obvious ways: + + - Set the appropriate fields in the `noxconfig.py` project configuration (`PROJECT_CONFIG`): + * `python_versions = [ ... ]` + * `exasol_versions = [ ... ]` + - Overwrite the nox tasks: + * `matrix:all` + * `matrix:python` + * `matrix:exasol` + - Overwrite/replace the matrix generation workflows: + * `matrix-all.yml` + * `matrix-python.yml` + * `matrix-exasol.yml` + + Among all of the above, the safest way is to set the matrix-related fields in your project config object in `noxconfig.py`. + +* Added a nox task to validate the build/test artifacts and use it in the github workflow report + + +## 📚 Documentation + +* Added new entries to the frequently asked questions regarding `multiversion documentation` + + +## 🐞 Fixed + +* Fixed `index.rst` documentation template to provide the correct underlining length of the main heading +* Added multi-version extension to Sphinx configuration of the project template +* fixed bug in tbx worflow install error if directory exists [#298](https://github.com/exasol/python-toolbox/issues/298) also [#297](https://github.com/exasol/python-toolbox/issues/297) + +## 🔩 Internal +* Relocked dependencies diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index 2f9aa42c0..79e701b84 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.md @@ -1,49 +1 @@ # Unreleased - -## 🚨 Breaking Changes -* **Matrices in CI/CD workflows will be generated automatically now** - - Make sure you have installed all the latest workflow files, especially the newly added ones: - - - `matrix-all.yml` - - `matrix-python.yml` - - `matrix-exasol.yml` - - -## ✨ Added -* Added support for dynamically generated workflow matrices. - - This feature allows you to easily change the test matrices in one place: `noxconfig.py`. - - Note: As usual, there are different ways a user can adjust or change the behavior. In the case of the build matrices, there are three obvious ways: - - - Set the appropriate fields in the `noxconfig.py` project configuration (`PROJECT_CONFIG`): - * `python_versions = [ ... ]` - * `exasol_versions = [ ... ]` - - Overwrite the nox tasks: - * `matrix:all` - * `matrix:python` - * `matrix:exasol` - - Overwrite/replace the matrix generation workflows: - * `matrix-all.yml` - * `matrix-python.yml` - * `matrix-exasol.yml` - - Among all of the above, the safest way is to set the matrix-related fields in your project config object in `noxconfig.py`. - -* Added a nox task to validate the build/test artifacts and use it in the github workflow report - - -## 📚 Documentation - -* Added new entries to the frequently asked questions regarding `multiversion documentation` - - -## 🐞 Fixed - -* Fixed `index.rst` documentation template to provide the correct underlining length of the main heading -* Added multi-version extension to Sphinx configuration of the project template -* fixed bug in tbx worflow install error if directory exists [#298](https://github.com/exasol/python-toolbox/issues/298) also [#297](https://github.com/exasol/python-toolbox/issues/297) - -## 🔩 Internal -* Relocked dependencies diff --git a/exasol/toolbox/templates/github/workflows/build-and-publish.yml b/exasol/toolbox/templates/github/workflows/build-and-publish.yml index f25d7f353..dffc29997 100644 --- a/exasol/toolbox/templates/github/workflows/build-and-publish.yml +++ b/exasol/toolbox/templates/github/workflows/build-and-publish.yml @@ -17,7 +17,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Build Artifacts run: poetry build diff --git a/exasol/toolbox/templates/github/workflows/check-release-tag.yml b/exasol/toolbox/templates/github/workflows/check-release-tag.yml index a89193b68..31989d34e 100644 --- a/exasol/toolbox/templates/github/workflows/check-release-tag.yml +++ b/exasol/toolbox/templates/github/workflows/check-release-tag.yml @@ -14,7 +14,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Check Tag Version # make sure the pushed/created tag matched the project version diff --git a/exasol/toolbox/templates/github/workflows/checks.yml b/exasol/toolbox/templates/github/workflows/checks.yml index 0d737e643..20a8f81bb 100644 --- a/exasol/toolbox/templates/github/workflows/checks.yml +++ b/exasol/toolbox/templates/github/workflows/checks.yml @@ -19,7 +19,7 @@ jobs: fetch-depth: 0 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Check Version(s) run: | @@ -40,7 +40,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Build Documentation run: | @@ -63,7 +63,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 with: python-version: ${{ matrix.python-version }} @@ -90,7 +90,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 with: python-version: ${{ matrix.python-version }} @@ -110,7 +110,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 with: python-version: ${{ matrix.python-version }} @@ -133,7 +133,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 with: python-version: "3.9" @@ -155,7 +155,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 with: python-version: ${{ matrix.python-version }} diff --git a/exasol/toolbox/templates/github/workflows/gh-pages.yml b/exasol/toolbox/templates/github/workflows/gh-pages.yml index 3bc430e0d..698fd3c7d 100644 --- a/exasol/toolbox/templates/github/workflows/gh-pages.yml +++ b/exasol/toolbox/templates/github/workflows/gh-pages.yml @@ -16,7 +16,7 @@ jobs: fetch-depth: 0 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Build Documentation run: | diff --git a/exasol/toolbox/templates/github/workflows/matrix-all.yml b/exasol/toolbox/templates/github/workflows/matrix-all.yml index b23406b89..eeeb379c1 100644 --- a/exasol/toolbox/templates/github/workflows/matrix-all.yml +++ b/exasol/toolbox/templates/github/workflows/matrix-all.yml @@ -17,7 +17,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Generate matrix run: poetry run nox -s matrix:all diff --git a/exasol/toolbox/templates/github/workflows/matrix-exasol.yml b/exasol/toolbox/templates/github/workflows/matrix-exasol.yml index 279b5ae30..7d11ef5ef 100644 --- a/exasol/toolbox/templates/github/workflows/matrix-exasol.yml +++ b/exasol/toolbox/templates/github/workflows/matrix-exasol.yml @@ -17,7 +17,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Generate matrix run: poetry run nox -s matrix:exasol diff --git a/exasol/toolbox/templates/github/workflows/matrix-python.yml b/exasol/toolbox/templates/github/workflows/matrix-python.yml index 0ee1ee889..58a618a89 100644 --- a/exasol/toolbox/templates/github/workflows/matrix-python.yml +++ b/exasol/toolbox/templates/github/workflows/matrix-python.yml @@ -17,7 +17,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Generate matrix run: poetry run nox -s matrix:python diff --git a/exasol/toolbox/templates/github/workflows/report.yml b/exasol/toolbox/templates/github/workflows/report.yml index 682e1673d..a84f9feca 100644 --- a/exasol/toolbox/templates/github/workflows/report.yml +++ b/exasol/toolbox/templates/github/workflows/report.yml @@ -20,7 +20,7 @@ jobs: fetch-depth: 0 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 - name: Download Artifacts uses: actions/download-artifact@v4.1.8 diff --git a/exasol/toolbox/templates/github/workflows/slow-checks.yml b/exasol/toolbox/templates/github/workflows/slow-checks.yml index b898e9ceb..efb95c021 100644 --- a/exasol/toolbox/templates/github/workflows/slow-checks.yml +++ b/exasol/toolbox/templates/github/workflows/slow-checks.yml @@ -31,7 +31,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.20.0 with: python-version: ${{ matrix.python-version }} diff --git a/exasol/toolbox/version.py b/exasol/toolbox/version.py index de906d925..0f4705282 100644 --- a/exasol/toolbox/version.py +++ b/exasol/toolbox/version.py @@ -5,7 +5,7 @@ # Do not edit this file manually! # If you need to change the version, do so in the project.toml, e.g. by using `poetry version X.Y.Z`. MAJOR = 0 -MINOR = 19 +MINOR = 20 PATCH = 0 VERSION = f"{MAJOR}.{MINOR}.{PATCH}" __version__ = VERSION diff --git a/pyproject.toml b/pyproject.toml index 03fbae6de..f9603997d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "exasol-toolbox" packages = [ { include = "exasol" }, ] -version = "0.19.0" +version = "0.20.0" description = "Your one-stop solution for managing all standard tasks and core workflows of your Python project." authors = [ "Nicola Coretti "