Skip to content

Commit

Permalink
Prepare release 0.20.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicoretti committed Dec 16, 2024
1 parent c220329 commit 5a5149e
Show file tree
Hide file tree
Showing 14 changed files with 68 additions and 65 deletions.
2 changes: 2 additions & 0 deletions doc/changes/changelog.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -28,6 +29,7 @@
hidden:
---
unreleased
changes_0.20.0
changes_0.19.0
changes_0.18.0
changes_0.17.0
Expand Down
49 changes: 49 additions & 0 deletions doc/changes/changes_0.20.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 0.20.0 - 2024-12-16

## 🚨 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
48 changes: 0 additions & 48 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions exasol/toolbox/templates/github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand All @@ -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: |
Expand All @@ -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 }}

Expand All @@ -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 }}

Expand All @@ -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 }}

Expand All @@ -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"

Expand All @@ -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 }}

Expand Down
2 changes: 1 addition & 1 deletion exasol/toolbox/templates/github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down
2 changes: 1 addition & 1 deletion exasol/toolbox/templates/github/workflows/matrix-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion exasol/toolbox/templates/github/workflows/report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]
Expand Down
2 changes: 1 addition & 1 deletion exasol/toolbox/templates/github/workflows/slow-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}

Expand Down
2 changes: 1 addition & 1 deletion exasol/toolbox/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 <[email protected]>"
Expand Down

0 comments on commit 5a5149e

Please sign in to comment.