Skip to content

Commit

Permalink
Prepare release 0.9.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicoretti authored May 8, 2024
1 parent d31f913 commit 4f46dc1
Show file tree
Hide file tree
Showing 10 changed files with 69 additions and 66 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 @@
# 📝 Changes

* [unreleased](unreleased.md)
* [0.9.0](changes_0.9.0.md)
* [0.8.0](changes_0.8.0.md)
* [0.7.0](changes_0.7.0.md)
* [0.6.2](changes_0.6.2.md)
Expand All @@ -17,6 +18,7 @@
hidden:
---
unreleased
changes_0.9.0
changes_0.8.0
changes_0.7.0
changes_0.6.2
Expand Down
56 changes: 56 additions & 0 deletions doc/changes/changes_0.9.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# 0.9.0 - 2024-05-08

## 🚨 Breaking Changes
* **CI-CD Workflow (Breaking Change)**

**Overview:**

The CI-CD workflow now assumes the changelog to be in markdown and the location `/doc/changes/change_x.y.z.md`

## 🐞 Fixed
* Fixed `_deny_filter` function in `exasol.toolbox._shared` module
* Fixed GitHub workflow references in `ci.yml`, ci-cd.yml` and `pr-merge.yml` workflows
* Fixed indent error/issue in `checks.yml` workflow

## ✨ Added
* **Added Nox Task `prepare-release`**

**Overview:**

A new Nox task, `prepare-release`, has been introduced to streamline the release preparation process. This task automates several crucial steps:

- Create a dedicated branch for the release changes.
- Transfer changes from the "Unreleased" section to the appropriate versioned changelog section.
- Update the version number to the next release.
- Initiate a Pull Request (PR) for review and integration into the main branch.

**Usage:**

To prepare a release, simply execute a command in your terminal like in the example below:

```shell
nox -s prepare-release -- 1.10.1
```

Add the changes for releasing on top of the current branch:

```shell
nox -s prepare-release -- 1.10.1 --no-pr --no-branch
```

For additional options and help regarding the task `prepare-release`, execute:

```shell
nox -s prepare-release -- -h
```

* **Added Plugin Support for Nox Task `prepare-release`**

- For further details on the plugin specification, refer to `exasol.toolbox.nox.plugin`.
- For an example of usage, refer to the `noxconfig` of the Python toolbox.

## 📚 Documentation
* Fixed typos and updated documentation

## 🔩 Internal
* Restructured `exasol.toolbox.nox` module
55 changes: 0 additions & 55 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
@@ -1,56 +1 @@
# Unreleased

## 🚨 Breaking Changes
* **CI-CD Workflow (Breaking Change)**

**Overview:**

The CI-CD workflow now assumes the changelog to be in markdown and the location `/doc/changes/change_x.y.z.md`

## 🐞 Fixed
* Fixed `_deny_filter` function in `exasol.toolbox._shared` module
* Fixed GitHub workflow references in `ci.yml`, ci-cd.yml` and `pr-merge.yml` workflows
* Fixed indent error/issue in `checks.yml` workflow

## ✨ Added
* **Added Nox Task `prepare-release`**

**Overview:**

A new Nox task, `prepare-release`, has been introduced to streamline the release preparation process. This task automates several crucial steps:

- Create a dedicated branch for the release changes.
- Transfer changes from the "Unreleased" section to the appropriate versioned changelog section.
- Update the version number to the next release.
- Initiate a Pull Request (PR) for review and integration into the main branch.

**Usage:**

To prepare a release, simply execute a command in your terminal like in the example below:

```shell
nox -s prepare-release -- 1.10.1
```

Add the changes for releasing on top of the current branch:

```shell
nox -s prepare-release -- 1.10.1 --no-pr --no-branch
```

For additional options and help regarding the task `prepare-release`, execute:

```shell
nox -s prepare-release -- -h
```

* **Added Plugin Support for Nox Task `prepare-release`**

- For further details on the plugin specification, refer to `exasol.toolbox.nox.plugin`.
- For an example of usage, refer to the `noxconfig` of the Python toolbox.

## 📚 Documentation
* Fixed typos and updated documentation

## 🔩 Internal
* Restructured `exasol.toolbox.nox` module
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
uses: actions/checkout@v3

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.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@v3

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0

- name: Check Tag Version
# make sure the pushed/created tag matched the project version
Expand Down
10 changes: 5 additions & 5 deletions exasol/toolbox/templates/github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
fetch-depth: 0

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0

- name: Check Version(s)
run: poetry run version-check <<Add path to version.py file>>
Expand All @@ -30,7 +30,7 @@ jobs:
uses: actions/checkout@v3

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0

- name: Build Documentation
run: |
Expand All @@ -50,7 +50,7 @@ jobs:
uses: actions/checkout@v3

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0
with:
python-version: ${{ matrix.python-version }}

Expand All @@ -71,7 +71,7 @@ jobs:
uses: actions/checkout@v3

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0
with:
python-version: ${{ matrix.python-version }}

Expand All @@ -93,7 +93,7 @@ jobs:
uses: actions/checkout@v3

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.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 @@ -12,7 +12,7 @@ jobs:
uses: actions/checkout@v3

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0

- name: Build Documentation
run: |
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 @@ -21,7 +21,7 @@ jobs:
fetch-depth: 0

- name: Setup Python & Poetry Environment
uses: exasol/python-toolbox/.github/actions/python-environment@0.8.0
uses: exasol/python-toolbox/.github/actions/python-environment@0.9.0

- name: Download Artifacts
uses: actions/download-artifact@v3
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,6 +5,6 @@
# 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 = 8
MINOR = 9
PATCH = 0
VERSION = f"{MAJOR}.{MINOR}.{PATCH}"
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.8.0"
version = "0.9.0"
description = ""
authors = [
"Nicola Coretti <[email protected]>"
Expand Down

0 comments on commit 4f46dc1

Please sign in to comment.