Skip to content

Commit 4611558

Browse files
Merge branch 'main' into feature/#149-add-support-for-import-linter-to-lint-tasks
2 parents 9a240f8 + 9876aa8 commit 4611558

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+650
-1808
lines changed

.github/actions/python-environment/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ inputs:
66
python-version:
77
description: 'Python version to use'
88
required: true
9-
default: "3.8"
9+
default: "3.10"
1010

1111
poetry-version:
1212
description: 'Poetry version to use'

.github/workflows/checks.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ jobs:
3838

3939
- name: Build Documentation
4040
run: |
41-
poetry run python -m nox -s build-docs
41+
poetry run python -m nox -s docs:build
4242
4343
Lint:
4444
name: Linting (Python-${{ matrix.python-version }})
@@ -47,7 +47,7 @@ jobs:
4747
strategy:
4848
fail-fast: false
4949
matrix:
50-
python-version: [ "3.8", "3.9", "3.10", "3.11" ]
50+
python-version: [ "3.9", "3.10", "3.11" ]
5151

5252
steps:
5353
- name: SCM Checkout
@@ -59,7 +59,7 @@ jobs:
5959
python-version: ${{ matrix.python-version }}
6060

6161
- name: Run lint
62-
run: poetry run nox -s lint
62+
run: poetry run nox -s lint:code
6363

6464
- name: Upload Artifacts
6565
uses: actions/[email protected]
@@ -75,7 +75,7 @@ jobs:
7575
strategy:
7676
fail-fast: false
7777
matrix:
78-
python-version: [ "3.8", "3.9", "3.10", "3.11" ]
78+
python-version: [ "3.9", "3.10", "3.11" ]
7979

8080
steps:
8181
- name: SCM Checkout
@@ -87,7 +87,7 @@ jobs:
8787
python-version: ${{ matrix.python-version }}
8888

8989
- name: Run type-check
90-
run: poetry run nox -s type-check
90+
run: poetry run nox -s lint:typing
9191

9292
Security:
9393
name: Security Checks (Python-${{ matrix.python-version }})
@@ -96,7 +96,7 @@ jobs:
9696
strategy:
9797
fail-fast: false
9898
matrix:
99-
python-version: [ "3.8", "3.9", "3.10", "3.11" ]
99+
python-version: [ "3.9", "3.10", "3.11" ]
100100

101101
steps:
102102
- name: SCM Checkout
@@ -108,7 +108,7 @@ jobs:
108108
python-version: ${{ matrix.python-version }}
109109

110110
- name: Run security linter
111-
run: poetry run nox -s security
111+
run: poetry run nox -s lint:security
112112

113113
- name: Upload Artifacts
114114
uses: actions/[email protected]
@@ -126,7 +126,7 @@ jobs:
126126
strategy:
127127
fail-fast: false
128128
matrix:
129-
python-version: [ "3.8", "3.9", "3.10", "3.11" ]
129+
python-version: [ "3.9", "3.10", "3.11" ]
130130
exasol-version: [ "7.1.9" ]
131131

132132
steps:
@@ -139,7 +139,7 @@ jobs:
139139
python-version: ${{ matrix.python-version }}
140140

141141
- name: Run Tests and Collect Coverage
142-
run: poetry run nox -s coverage -- -- --db-version ${{ matrix.exasol-version }}
142+
run: poetry run nox -s test:coverage -- -- --db-version ${{ matrix.exasol-version }}
143143

144144
- name: Upload Artifacts
145145
uses: actions/[email protected]

.github/workflows/gh-pages.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ jobs:
1010
steps:
1111
- name: SCM Checkout
1212
uses: actions/checkout@v4
13+
with:
14+
fetch-depth: 0
1315

1416
- name: Setup Python & Poetry Environment
1517
uses: ./.github/actions/python-environment
1618

1719
- name: Build Documentation
1820
run: |
19-
poetry run python -m nox -s build-docs
21+
poetry run python -m nox -s docs:multiversion
2022
2123
- name: Deploy
2224
uses: JamesIves/[email protected]

.github/workflows/report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535
cp security-python3.9/.security.json ../
3636
3737
- name: Generate Report
38-
run: poetry run nox -s report -- -- --format json | tee metrics.json
38+
run: poetry run nox -s project:report -- -- --format json | tee metrics.json
3939

4040
- name: Upload Artifacts
4141
uses: actions/[email protected]
@@ -46,7 +46,7 @@ jobs:
4646
- name: Generate GitHub Summary
4747
run: |
4848
echo -e "# Summary\n" >> $GITHUB_STEP_SUMMARY
49-
poetry run nox -s report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
49+
poetry run nox -s project:report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
5050
echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
5151
poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
5252
echo -e "\n\n# Static Code Analysis\n" >> $GITHUB_STEP_SUMMARY

doc/_templates/version.html

Lines changed: 0 additions & 12 deletions
This file was deleted.

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+
* [0.16.0](changes_0.16.0.md)
45
* [0.15.0](changes_0.15.0.md)
56
* [0.14.0](changes_0.14.0.md)
67
* [0.13.0](changes_0.13.0.md)
@@ -24,6 +25,7 @@
2425
hidden:
2526
---
2627
unreleased
28+
changes_0.16.0
2729
changes_0.15.0
2830
changes_0.14.0
2931
changes_0.13.0

doc/changes/changes_0.15.0.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
* Added cookiecutter-template for creating new project
66
* [#246](https://github.com/exasol/python-toolbox/issues/246): Added standard branch protection workflow
7+
* #74: Added security linter nox task
78

89
## 🐞 Bug Fixes
910

doc/changes/changes_0.16.0.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# 0.16.0 - 2024-11-15
2+
3+
## 🚨 Breaking Changes
4+
5+
* Dropped python 3.8 support
6+
* Changed names of all nox tasks
7+
8+
| Old Name | New Name | Description |
9+
|--------------------|------------------------|----------------------------------------------------------------|
10+
| fix | project:fix | Runs all automated fixes on the code base |
11+
| check | project:check | Runs all available checks on the project |
12+
| report | project:report | Collects and generates metrics summary for the workspace |
13+
| unit-tests | test:unit | Runs all unit tests |
14+
| integration-tests | test:integration | Runs all the integration tests |
15+
| coverage | test:coverage | Runs all tests (unit + integration) and reports the code coverage |
16+
| lint | lint:code | Runs the static code analyzer on the project |
17+
| type-check | lint:typing | Runs the type checker on the project |
18+
| security | lint:security | Runs the security linter on the project |
19+
| build-build | docs:build | Builds the project documentation |
20+
| open-open | docs:open | Opens the built project documentation |
21+
| clean-docs | docs:clean | Removes the documentations build folder |
22+
| prepare-release | release:prepare | Prepares the project for a new release |
23+
24+
## ✨ Added
25+
26+
* Added support for multi version Documentation
27+
* Added nox tasks for building multi-version documentation
28+
29+
## 🐞 Fixed
30+
31+
* Fixed CD workflow template
32+
* Fixed the selection of the latest version in Multi-Version Documentation
33+
34+
## 📚 Documentation
35+
36+
* Added Documentation on Metrics
37+
* Added additional details regarding adjusted sphinx-multiversion
38+
* Restructured documentation
39+
40+
## 🔩 Internal
41+
42+
* Relocked dependencies

doc/changes/unreleased.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,5 @@
11
# Unreleased
22

3-
## 🐞 Fixed
4-
5-
* Fixed CD workflow template
6-
73
## ✨ Features
84

9-
* #149: Added nox task to lint imports
10-
11-
## 📚 Documentation
12-
13-
* Add Documentation on Metrics
14-
15-
## 🔩 Internal
16-
17-
* Relock dependencies
18-
5+
* #149: Added nox task to lint imports

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
"sphinx_design",
3939
"sphinx_inline_tabs",
4040
"sphinx_copybutton",
41+
"exasol.toolbox.sphinx.multiversion",
4142
]
4243

4344
intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}

0 commit comments

Comments
 (0)