Skip to content

Commit d8a216b

Browse files
ArBridgemantomuben
ArBridgeman
and
tomuben
authored
Release/prepare 1.6.1 (#496)
* Update documentation with exclusion & add summary to unreleased * Prepare version 1.6.1. * Update doc/changes/changes_1.6.1.md Co-authored-by: Thomas Ubensee <34603111+tomuben@users.noreply.github.com> --------- Co-authored-by: Thomas Ubensee <34603111+tomuben@users.noreply.github.com>
1 parent 2064c8a commit d8a216b

File tree

17 files changed

+59
-34
lines changed

17 files changed

+59
-34
lines changed

‎.github/actions/security-issues/action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ runs:
3939
- name: Install Python Toolbox / Security tool
4040
shell: bash
4141
run: |
42-
pip install exasol-toolbox==1.6.0
42+
pip install exasol-toolbox==1.6.1
4343
4444
- name: Create Security Issue Report
4545
shell: bash

‎doc/changes/changelog.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Changelog
22

33
* [unreleased](unreleased.md)
4+
* [1.6.1](changes_1.6.1.md)
45
* [1.6.0](changes_1.6.0.md)
56
* [1.5.0](changes_1.5.0.md)
67
* [1.4.0](changes_1.4.0.md)
@@ -38,6 +39,7 @@
3839
hidden:
3940
---
4041
unreleased
42+
changes_1.6.1
4143
changes_1.6.0
4244
changes_1.5.0
4345
changes_1.4.0

‎doc/changes/changes_1.6.1.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# 1.6.1 - 2025-07-16
2+
3+
## Summary
4+
5+
This version of the PTB resolves many bugs associated with the cookiecutter template
6+
and creating a new project that uses the PTB.
7+
8+
If any directories or files specified in your `noxconfig.py` via `Config.source` should
9+
not be included in a Sonar analysis, it is recommended to add the following to
10+
your `pyproject.toml` under the `[tool.sonar]` section:
11+
12+
```toml
13+
exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
14+
```
15+
16+
## Bugfixes
17+
18+
* #489: Fixed .pre-commit-config.yaml to use existing nox tasks
19+
* #490: Fixed artifacts:validate & sonar:check to work for newly created projects
20+
* #484: Fixed hint command text in version.py to include -s for executing nox task
21+
22+
## Documentation
23+
24+
* #488: Updated user guide to make clearer under which conditions branch protections based on GitHub actions can be enacted
25+
26+
## Refactoring
27+
28+
* #482: Updated pull_request_template.md to reflect checks we should regularly perform

‎doc/changes/unreleased.md‎

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1 @@
11
# Unreleased
2-
3-
## Bugfixes
4-
5-
* #489: Fixed .pre-commit-config.yaml to use existing nox tasks
6-
* #490: Fixed artifacts:validate & sonar:check to work for newly created projects
7-
* #484: Fixed hint command text in version.py to include -s for executing nox task
8-
9-
## Documentation
10-
11-
* #488: Updated user guide to make clearer under which conditions branch protections based on GitHub actions can be enacted
12-
13-
## Refactoring
14-
15-
* #482: Updated pull_request_template.md to reflect checks we should regularly perform

‎doc/user_guide/getting_started.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ For a **public** project
229229
projectKey = "com.exasol:<project-key>"
230230
hostUrl = "https://sonarcloud.io"
231231
organization = "exasol"
232+
exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
232233
6. Post-merge, update the branch protections to include SonarQube analysis
233234

234235
* This should only be done when tests exist for the project, & that the project is
@@ -253,8 +254,15 @@ For a **private** project
253254
projectKey = "com.exasol:<project-key>"
254255
hostUrl = "https://sonar.exasol.com"
255256
organization = "exasol"
257+
exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
256258
6. Post-merge, update the branch protections to include SonarQube analysis from exasonarqubeprchecks
257259

260+
* This should only be done when tests exist for the project, & that the project is
261+
at a state in which enforced code coverage would not be a burden. For new projects,
262+
we recommend creating an issue to add the SonarQube analysis to the branch protections
263+
at a later point. In such scenarios, SonarQube analysis will still report its analysis
264+
results to the PR, but it will not prevent the PR from being merged.
265+
258266
9. Go 🥜
259267
+++++++++++++
260268
You are ready to use the toolbox. With *nox -l* you can list all available tasks.

‎exasol/toolbox/nox/_package_version.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@
2020

2121
# fmt: off
2222
_VERSION_MODULE_TEMPLATE = cleandoc('''
23-
""" ATTENTION:
23+
"""ATTENTION:
2424
This file is generated by exasol/toolbox/nox/_package_version.py when using:
2525
* either "poetry run -- nox -s project:fix"
2626
* or "poetry run -- nox -s version:check -- --fix"
2727
Do not edit this file manually!
2828
If you need to change the version, do so in the pyproject.toml, e.g. by using
2929
`poetry version X.Y.Z`.
3030
"""
31+
3132
MAJOR = {major}
3233
MINOR = {minor}
3334
PATCH = {patch}

‎exasol/toolbox/templates/github/workflows/build-and-publish.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
uses: actions/checkout@v4
1919

2020
- name: Setup Python & Poetry Environment
21-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
21+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
2222

2323
- name: Build Artifacts
2424
run: poetry build

‎exasol/toolbox/templates/github/workflows/check-release-tag.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
uses: actions/checkout@v4
1616

1717
- name: Setup Python & Poetry Environment
18-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
18+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
1919

2020
- name: Check Tag Version
2121
# make sure the pushed/created tag matched the project version

‎exasol/toolbox/templates/github/workflows/checks.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ jobs:
1616
fetch-depth: 0
1717

1818
- name: Setup Python & Poetry Environment
19-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
19+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
2020

2121
- name: Check Version(s)
2222
run: poetry run -- nox -s version:check
@@ -32,7 +32,7 @@ jobs:
3232
uses: actions/checkout@v4
3333

3434
- name: Setup Python & Poetry Environment
35-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
35+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
3636

3737
- name: Build Documentation
3838
run: |
@@ -59,7 +59,7 @@ jobs:
5959
uses: actions/checkout@v4
6060

6161
- name: Setup Python & Poetry Environment
62-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
62+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
6363

6464
- name: Run changelog update check
6565
run: poetry run -- nox -s changelog:updated
@@ -78,7 +78,7 @@ jobs:
7878
uses: actions/checkout@v4
7979

8080
- name: Setup Python & Poetry Environment
81-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
81+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
8282
with:
8383
python-version: ${{ matrix.python-version }}
8484

@@ -109,7 +109,7 @@ jobs:
109109
uses: actions/checkout@v4
110110

111111
- name: Setup Python & Poetry Environment
112-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
112+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
113113
with:
114114
python-version: ${{ matrix.python-version }}
115115

@@ -131,7 +131,7 @@ jobs:
131131
uses: actions/checkout@v4
132132

133133
- name: Setup Python & Poetry Environment
134-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
134+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
135135
with:
136136
python-version: ${{ matrix.python-version }}
137137

@@ -155,7 +155,7 @@ jobs:
155155
uses: actions/checkout@v4
156156

157157
- name: Setup Python & Poetry Environment
158-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
158+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
159159

160160
- name: Run format check
161161
run: poetry run -- nox -s project:format
@@ -177,7 +177,7 @@ jobs:
177177
uses: actions/checkout@v4
178178

179179
- name: Setup Python & Poetry Environment
180-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
180+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
181181
with:
182182
python-version: ${{ matrix.python-version }}
183183

‎exasol/toolbox/templates/github/workflows/gh-pages.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
fetch-depth: 0
1818

1919
- name: Setup Python & Poetry Environment
20-
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
20+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.1
2121

2222
- name: Build Documentation
2323
run: |

0 commit comments

Comments
 (0)