diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md index a2e09da4d..a360fbc44 100644 --- a/doc/changes/changelog.md +++ b/doc/changes/changelog.md @@ -1,6 +1,7 @@ # Changelog * [unreleased](unreleased.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) * [0.16.0](changes_0.16.0.md) @@ -27,6 +28,7 @@ hidden: --- unreleased +changes_0.19.0 changes_0.18.0 changes_0.17.0 changes_0.16.0 diff --git a/doc/changes/changes_0.19.0.md b/doc/changes/changes_0.19.0.md new file mode 100644 index 000000000..1ff30235f --- /dev/null +++ b/doc/changes/changes_0.19.0.md @@ -0,0 +1,25 @@ +# 0.19.0 - 2024-12-05 + +## 🔧 Changed + +* Add `__version__` member to generated `version.py` for compatibility with other versions schemes +* Excluded pyupgrade from project check due to its destructive nature +* Updated cookiecutter template + - removed obsolete template file `version.html` +* Added nox task for format checking +* Updated GitHub workflow and workflow template of `checks.yml` to include format check + +## 🐞 Fixed + +* Fixed whitespace and final newline behavior in `release:prepare` to work well with `trailing whitespace` commit hook +* Fixed syntax error in the `check.yml` template which resulted in an invalid workflow file +* Fixed context forwarding to plugins hooking into `pre` and `post` integration test hooks + - `pre_integration_tests_hook(self, session, config, context)` + - `post_integration_tests_hook(self, session, config, context)` + +## 📚 Documentation + +* Fixed various documentation typos +* Added a toolbox migration guide +* Fixed version information in GitHub Actions reference +* Updated the `pre-commit` related documentation diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index 9624485c3..79e701b84 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.md @@ -1,24 +1 @@ # Unreleased - -## 🔧 Changed - -* Add `__version__` member to generated `version.py` for compatibility with other versions schemes -* Excluded pyupgrade from project check due to its destructive nature -* Updated cookiecutter template - - removed obsolete template file `version.html` -* Added nox task for format checking -* Updated GitHub workflow and workflow template of `checks.yml` to include format check - -## 🐞 Fixed - -* Fixed syntax error in the `check.yml` template which resulted in an invalid workflow file -* Fixed context forwarding to plugins hooking into `pre` and `post` integration test hooks - - `pre_integration_tests_hook(self, session, config, context)` - - `post_integration_tests_hook(self, session, config, context)` - -## 📚 Documentation - -* Fixed various documentation typos -* Added a toolbox migration guide -* Fixed version information in GitHub Actions reference -* Updated the `pre-commit` related documentation diff --git a/exasol/toolbox/release/__init__.py b/exasol/toolbox/release/__init__.py index 84cec6dd1..ad4ca5deb 100644 --- a/exasol/toolbox/release/__init__.py +++ b/exasol/toolbox/release/__init__.py @@ -92,6 +92,7 @@ def extract_release_notes(file: str | Path) -> str: lines = f.readlines()[1:] content = "".join(lines) content = cleandoc(content) + content += "\n" return content diff --git a/exasol/toolbox/templates/github/workflows/build-and-publish.yml b/exasol/toolbox/templates/github/workflows/build-and-publish.yml index 4ba1b6593..f25d7f353 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.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.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 5415fd0b6..a89193b68 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.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.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 51cfc73ae..04896a795 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.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.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.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 - name: Build Documentation run: | @@ -60,7 +60,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 with: python-version: ${{ matrix.python-version }} @@ -88,7 +88,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 with: python-version: ${{ matrix.python-version }} @@ -109,7 +109,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 with: python-version: ${{ matrix.python-version }} @@ -132,7 +132,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 with: python-version: "3.9" - name: Run format check @@ -155,7 +155,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.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 dfdac638a..3bc430e0d 100644 --- a/exasol/toolbox/templates/github/workflows/gh-pages.yml +++ b/exasol/toolbox/templates/github/workflows/gh-pages.yml @@ -1,6 +1,6 @@ name: Publish Documentation -on: +on: workflow_call: workflow_dispatch: @@ -16,7 +16,7 @@ jobs: fetch-depth: 0 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 - name: Build Documentation run: | diff --git a/exasol/toolbox/templates/github/workflows/report.yml b/exasol/toolbox/templates/github/workflows/report.yml index c0deae394..682e1673d 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.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.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 961734b82..21d635921 100644 --- a/exasol/toolbox/templates/github/workflows/slow-checks.yml +++ b/exasol/toolbox/templates/github/workflows/slow-checks.yml @@ -28,7 +28,7 @@ jobs: uses: actions/checkout@v4 - name: Setup Python & Poetry Environment - uses: exasol/python-toolbox/.github/actions/python-environment@0.18.0 + uses: exasol/python-toolbox/.github/actions/python-environment@0.19.0 with: python-version: ${{ matrix.python-version }} diff --git a/exasol/toolbox/version.py b/exasol/toolbox/version.py index e62424cd5..de906d925 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 = 18 +MINOR = 19 PATCH = 0 VERSION = f"{MAJOR}.{MINOR}.{PATCH}" __version__ = VERSION diff --git a/pyproject.toml b/pyproject.toml index bdddcbeda..03fbae6de 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ name = "exasol-toolbox" packages = [ { include = "exasol" }, ] -version = "0.18.0" +version = "0.19.0" description = "Your one-stop solution for managing all standard tasks and core workflows of your Python project." authors = [ "Nicola Coretti " diff --git a/test/unit/release_test.py b/test/unit/release_test.py index 15f4df4c0..6fd1e391a 100644 --- a/test/unit/release_test.py +++ b/test/unit/release_test.py @@ -76,7 +76,7 @@ def test_version_from_poetry(poetry_version, version, expected): Version(0, 1, 0), cleandoc( """ - ## Added + ## Added * Some great feature ## Refactored @@ -88,7 +88,7 @@ def test_version_from_poetry(poetry_version, version, expected): """ # 0.1.0 - 2024-02-07 - ## Added + ## Added * Some great feature ## Refactored @@ -126,8 +126,9 @@ def unreleased_md(tmp_path): def test_extract_release_notes(unreleased_md): - expected = cleandoc( - """ + expected = ( + cleandoc( + """ ## ✨ Added * Added Awesome feature @@ -137,6 +138,8 @@ def test_extract_release_notes(unreleased_md): ## 🐞 Fixed * Fixed nasty bug """ + ) + + "\n" ) actual = extract_release_notes(unreleased_md) assert expected == actual