Skip to content

Commit 74e5352

Browse files
ArBridgemanArBridgeman
authored
Prepare release 1.6.0 (#480)
* Prepare release 1.6.0 * Rename nox tasks to be clearer what they do * Update changelog date * Make clearer what happens if links:check fails & quote code name
1 parent eca15f6 commit 74e5352

File tree

17 files changed

+64
-61
lines changed

17 files changed

+64
-61
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.5.0
42+
pip install exasol-toolbox==1.6.0
4343
4444
- name: Create Security Issue Report
4545
shell: bash

‎.github/workflows/checks.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ jobs:
4141
4242
- name: Link Check
4343
run: |
44-
poetry run -- nox -s docs:links:check
44+
poetry run -- nox -s links:check
4545
4646
4747
Changelog:

‎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.0](changes_1.6.0.md)
45
* [1.5.0](changes_1.5.0.md)
56
* [1.4.0](changes_1.4.0.md)
67
* [1.3.0](changes_1.3.0.md)
@@ -37,6 +38,7 @@
3738
hidden:
3839
---
3940
unreleased
41+
changes_1.6.0
4042
changes_1.5.0
4143
changes_1.4.0
4244
changes_1.3.0

‎doc/changes/changes_1.6.0.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# 1.6.0 - 2025-06-27
2+
3+
## Summary
4+
5+
### Links in the Documentation
6+
This version of the PTB adds nox tasks to check links present in our documentation:
7+
8+
links:list - List all the links within the documentation
9+
links:check - Checks whether all links in the documentation are accessible
10+
11+
`links:check` is run in the CI `checks.yml`. If this step fails in the CI, it will cause
12+
the build to break. Please check the output & manually resolve the issues. There might
13+
be some cases where you need to update your `doc/conf.py` with specific values for the allowed
14+
options for the [Linkcheck Builder](https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder).
15+
16+
We recommend the following values be added:
17+
18+
linkcheck_rate_limit_timeout = 60
19+
linkcheck_timeout = 15
20+
linkcheck_delay = 30
21+
linkcheck_retries = 2
22+
linkcheck_anchors = False
23+
linkcheck_ignore: list[str] = []
24+
linkcheck_allowed_redirects = {
25+
# All HTTP redirections from the source URI to
26+
# the canonical URI will be treated as "working".
27+
r"https://github\.com/.*": r"https://github\.com/login*"
28+
}
29+
30+
## ✨ Features
31+
* #409: Doc link & checks
32+
33+
## Refactoring
34+
* Switched deprecated Pydantic class-based `config` to `ConfigDict`
35+
36+
## Security
37+
* #477: Switched `sonar:check` to use `SONAR_TOKEN` from the environment

‎doc/changes/unreleased.md‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1 @@
11
# Unreleased
2-
3-
## Summary
4-
5-
### Links in the Documentation
6-
This version of the PTB adds nox tasks to check links present in our documentation:
7-
8-
docs:link - List all the links within the documentation
9-
docs:links:check - Checks whether all links in the documentation are accessible
10-
11-
`docs:links:check` is run in the CI `checks.yml`. If this step fails in the CI,
12-
please check the output & manually resolve the issues. There might be some cases
13-
where you need to update your doc/conf.py with specific values for the allowed
14-
options for the [Linkcheck Builder](https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder).
15-
16-
We recommend the following values be added:
17-
18-
linkcheck_rate_limit_timeout = 60
19-
linkcheck_timeout = 15
20-
linkcheck_delay = 30
21-
linkcheck_retries = 2
22-
linkcheck_anchors = False
23-
linkcheck_ignore: list[str] = []
24-
linkcheck_allowed_redirects = {
25-
# All HTTP redirections from the source URI to
26-
# the canonical URI will be treated as "working".
27-
r"https://github\.com/.*": r"https://github\.com/login*"
28-
}
29-
30-
## ✨ Features
31-
* #409: Doc link & checks
32-
33-
## Refactoring
34-
* Switched deprecated Pydantic class-based `config` to `ConfigDict`
35-
36-
## Security
37-
* #477: Switched `sonar:check` to use `SONAR_TOKEN` from the environment

‎exasol/toolbox/nox/_documentation.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ def _docs_links_check(doc_config: Path, args):
143143
)
144144

145145

146-
@nox.session(name="docs:links", python=False)
146+
@nox.session(name="links:list", python=False)
147147
def docs_list_links(session: Session) -> None:
148148
"""List all the links within the documentation."""
149149
r_code, text = _docs_list_links(PROJECT_CONFIG.doc)
@@ -152,12 +152,12 @@ def docs_list_links(session: Session) -> None:
152152
session.error()
153153

154154

155-
@nox.session(name="docs:links:check", python=False)
155+
@nox.session(name="links:check", python=False)
156156
def docs_links_check(session: Session) -> None:
157157
"""Checks whether all links in the documentation are accessible."""
158158
parser = argparse.ArgumentParser(
159-
prog="nox -s docs:links:check",
160-
usage="nox -s docs:links:check -- [-h] [-o |--output]",
159+
prog="nox -s links:check",
160+
usage="nox -s links:check -- [-h] [-o |--output]",
161161
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
162162
)
163163
parser.add_argument(

‎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.5.0
21+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
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.5.0
18+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
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: 9 additions & 9 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.5.0
19+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
2020

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

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

3737
- name: Build Documentation
3838
run: |
3939
poetry run -- nox -s docs:build
4040
4141
- name: Link Check
4242
run: |
43-
poetry run -- nox -s docs:links:check
43+
poetry run -- nox -s links:check
4444
4545
build-matrix:
4646
name: Generate Build Matrix
@@ -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.5.0
62+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
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.5.0
81+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
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.5.0
112+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
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.5.0
134+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
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.5.0
158+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
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.5.0
180+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
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.5.0
20+
uses: exasol/python-toolbox/.github/actions/python-environment@1.6.0
2121

2222
- name: Build Documentation
2323
run: |

0 commit comments

Comments
 (0)