Bugfix/514 fix version for autosummary (#516)

* Fix typos

* Alter docstring in version.py to pass autosummary

* Prepare release 1.7.1

* Add changelog.md to .gitattributes

Author: ArBridgeman

.gitattributes

@@ -1,2 +1,3 @@
 poetry.lock linguist-generated=true
 exasol/toolbox/version.py linguist-generated=true
+doc/changes/changelog.md linguist-generated=true

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

@@ -39,7 +39,7 @@ runs:
     - name: Install Python Toolbox / Security tool
       shell: bash
       run: |
-        pip install exasol-toolbox==1.7.0
+        pip install exasol-toolbox==1.7.1
 
     - name: Create Security Issue Report
       shell: bash

doc/changes/changelog.md

@@ -0,0 +1,9 @@
+# 1.7.1 - 2025-07-30
+## Documentation
+
+* #512: Consolidated and added to deploying documentation pages
+* #510: Consolidated information of metrics & updated to include more about Sonar
+
+# Bugfix
+
+* #514: Altered docstring in version.py to pass autosummary

doc/changes/changes_1.7.1.md

@@ -1,6 +1 @@
 # Unreleased
-
-## Documentation
-
-* #512: Consolidated and added to deploying documentation pages
-* #510: Consolidated information of metrics & updated to include more about Sonar

doc/changes/unreleased.md

@@ -14,7 +14,7 @@ of your project's documentation. PTB expects the project's documentation in dire
 primarily as ``rst`` files. The ``doc/conf.py`` acts as the configuration file for building the
 documentation.
 
-GitHub workflow ``checks.yml`` also runs the checks for the documention.
+GitHub workflow ``checks.yml`` also runs the checks for the documentation.
 This enables updating and fixing the documentation together with other changes in the same pull request.
 The final building & serving of the documentation happens in GitHub workflow ``gh-pages.yml``.
 

doc/user_guide/features/documentation/index.rst

@@ -27,7 +27,7 @@ of the Exasol Product Integration Team:
 * `Metrics Schema Project`_
 
 The Integration team runs regular aggregation of the metrics from all projects into a centralized data sink
-as decribed in the company Wiki.
+as described in the company Wiki.
 
 Development
 -----------

doc/user_guide/features/metrics/project_report.rst

@@ -20,10 +20,11 @@
 
 # fmt: off
 _VERSION_MODULE_TEMPLATE = cleandoc('''
-    """ATTENTION:
-    This file is generated by exasol/toolbox/nox/_package_version.py when using:
-       * either "poetry run -- nox -s project:fix"
-       * or "poetry run -- nox -s version:check -- --fix"
+    """
+    ATTENTION:
+        This file is generated by exasol/toolbox/nox/_package_version.py when using:
+            * either "poetry run -- nox -s project:fix"
+            * or "poetry run -- nox -s version:check -- --fix"
     Do not edit this file manually!
     If you need to change the version, do so in the pyproject.toml, e.g. by using
     `poetry version X.Y.Z`.

exasol/toolbox/nox/_package_version.py

@@ -18,7 +18,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.7.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.7.1
 
       - name: Build Artifacts
         run: poetry build

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

@@ -15,7 +15,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Setup Python & Poetry Environment
-        uses: exasol/python-toolbox/.github/actions/python-environment@1.7.0
+        uses: exasol/python-toolbox/.github/actions/python-environment@1.7.1
 
       - name: Check Tag Version
         # make sure the pushed/created tag matched the project version