Refactoring/680 remove needs in checks (#681)

* Remove not required needs
* Move single liners to be single lines in yaml
* Update PTB workflow with template
* Add question mark to step requiring manual approval (when activated)
* Remove private repo information
* Prepare release 5.1.0

Author: ArBridgeman

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

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

.github/workflows/checks.yml

@@ -26,7 +26,6 @@ jobs:
 
   Documentation:
     name: Docs
-    needs: [ Version-Check ]
     runs-on: "ubuntu-24.04"
     permissions:
       contents: read
@@ -41,12 +40,10 @@ jobs:
           poetry-version: "2.3.0"
 
       - name: Build Documentation
-        run: |
-          poetry run -- nox -s docs:build
+        run: poetry run -- nox -s docs:build
 
       - name: Link Check
-        run: |
-          poetry run -- nox -s links:check
+        run: poetry run -- nox -s links:check
 
   Changelog:
     name: Changelog Update Check
@@ -69,7 +66,6 @@ jobs:
 
   Lint:
     name: Linting (Python-${{ matrix.python-versions }})
-    needs: [ Version-Check ]
     runs-on: "ubuntu-24.04"
     permissions:
       contents: read
@@ -101,7 +97,6 @@ jobs:
 
   Type-Check:
     name: Type Checking (Python-${{ matrix.python-versions }})
-    needs: [ Version-Check ]
     runs-on: "ubuntu-24.04"
     permissions:
       contents: read
@@ -125,7 +120,6 @@ jobs:
 
   Security:
     name: Security Checks (Python-${{ matrix.python-versions }})
-    needs: [ Version-Check ]
     runs-on: "ubuntu-24.04"
     permissions:
       contents: read
@@ -175,7 +169,6 @@ jobs:
 
   Build-Packages:
     name: Build Package Check
-    needs: [ Documentation, Lint, Type-Check, Security, Format ]
     runs-on: "ubuntu-24.04"
     permissions:
       contents: read
@@ -212,7 +205,6 @@ jobs:
 
   Tests:
     name: Unit-Tests (Python-${{ matrix.python-versions }})
-    needs: [ Build-Packages, Lint-Imports ]
     runs-on: "ubuntu-24.04"
     permissions:
       contents: read

.github/workflows/merge-gate.yml

@@ -12,7 +12,7 @@ jobs:
       contents: read
 
   run-slow-tests:
-    name: Run Slow Tests
+    name: Run Slow Tests?
     runs-on: "ubuntu-24.04"
     permissions:
       contents: read

doc/changes/changelog.md

@@ -0,0 +1,21 @@
+# 5.1.0 - 2026-01-29
+
+## Summary
+
+## Feature
+
+* #673: Switched `checks.yml` to get Python versions for matrix from `BaseConfig`
+
+## Documentation
+
+* #676: Moved GitHub Workflows to be inside features & updated
+* #658: Removed configuration of Sonar for private repos
+
+## Refactoring
+
+* #680: Removed `needs` from `checks.yml`
+
+## Dependency Updates
+
+### `main`
+* Added dependency `sphinxcontrib-mermaid:2.0.0`

doc/changes/changes_5.1.0.md

@@ -1,11 +1,3 @@
 # Unreleased
 
 ## Summary
-
-## Feature
-
-* #673: Switched `checks.yml` to get Python versions for matrix from `BaseConfig`
-
-## Documentation
-
-* #676: Move GitHub Workflows to be inside features & updated

doc/changes/unreleased.md

@@ -62,49 +62,11 @@ In the code
 
 **Private** GitHub repository
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. note::
-    As of 2025-07-29, these instructions have not been used. Thus, they should be
-    scrutinized and refined when they are used to configure a private repository.
-
-In GitHub
-"""""""""
-A GitHub Admin will need to:
-
-#. Add the individual 'PRIVATE_SONAR_TOKEN' to the 'Organization secrets'
-#. Activate the `exasonarqubeprchecks App <https://github.com/apps/exasonarqubeprchecks>`__
-#. **Post-merge**: update the branch protections to include SonarQube analysis.
-
-  * This should only be done when tests exist for the project, & that the project is
-    at a state in which enforced code coverage would not be a burden. If you do
-    not enact branch protections, it is recommended to create an issue to do so later.
-
-In Sonar
-""""""""
-An IT Admin will need to:
-
-#. Create a project on https://sonar.exasol.com
-
-  * Project key should follow this pattern, e.g. ``com.exasol:python-toolbox``
-
-
-In the code
-"""""""""""
-#. Specify in the ``noxconfig.py`` the relative path to the project's source code in ``Config.source``
-    .. code-block:: python
-
-        source: Path = Path("exasol/<source-directory>")
-
-#. Add the following to the project's file ``pyproject.toml``
-    .. code-block:: toml
-
-        [tool.sonar]
-        projectKey = "com.exasol:<project-key>"
-        host.url = "https://sonar.exasol.com"
-        organization = "exasol"
-        exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
+See the company wiki for details on how to use Exasol's on-prem SonarQube cluster
+and the needed steps to configure for a private GitHub repository.
 
 .. note::
-    For more information, see the :ref:`General remarks <configuration_general_remarks>` section.
+    For more general information, see the :ref:`General remarks <configuration_general_remarks>` section.
 
 .. _Exasol Way: https://sonarcloud.io/organizations/exasol/quality_gates/show/AXxvLH-3BdtLlpiYmZhh
 .. _Sonar Matching Patterns: https://docs.sonarsource.com/sonarqube-server/project-administration/adjusting-analysis/setting-analysis-scope/defining-matching-patterns

doc/user_guide/features/metrics/sonar.rst

@@ -26,7 +26,6 @@ jobs:
 
   Documentation:
     name: Docs
-    needs: [ Version-Check ]
     runs-on: "(( os_version ))"
     permissions:
       contents: read
@@ -41,12 +40,10 @@ jobs:
           poetry-version: "(( dependency_manager_version ))"
 
       - name: Build Documentation
-        run: |
-          poetry run -- nox -s docs:build
+        run: poetry run -- nox -s docs:build
 
       - name: Link Check
-        run: |
-          poetry run -- nox -s links:check
+        run: poetry run -- nox -s links:check
 
   Changelog:
     name: Changelog Update Check
@@ -69,7 +66,6 @@ jobs:
 
   Lint:
     name: Linting (Python-${{ matrix.python-versions }})
-    needs: [ Version-Check ]
     runs-on: "(( os_version ))"
     permissions:
       contents: read
@@ -101,7 +97,6 @@ jobs:
 
   Type-Check:
     name: Type Checking (Python-${{ matrix.python-versions }})
-    needs: [ Version-Check ]
     runs-on: "(( os_version ))"
     permissions:
       contents: read
@@ -125,7 +120,6 @@ jobs:
 
   Security:
     name: Security Checks (Python-${{ matrix.python-versions }})
-    needs: [ Version-Check ]
     runs-on: "(( os_version ))"
     permissions:
       contents: read
@@ -175,7 +169,6 @@ jobs:
 
   Build-Packages:
     name: Build Package Check
-    needs: [ Documentation, Lint, Type-Check, Security, Format ]
     runs-on: "(( os_version ))"
     permissions:
       contents: read
@@ -194,7 +187,6 @@ jobs:
 
   Tests:
     name: Unit-Tests (Python-${{ matrix.python-versions }})
-    needs: [ Build-Packages ]
     runs-on: "(( os_version ))"
     permissions:
       contents: read

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

@@ -12,7 +12,7 @@ jobs:
       contents: read
 
   run-slow-tests:
-    name: Run Slow Tests
+    name: Run Slow Tests?
     runs-on: "(( os_version ))"
     permissions:
       contents: read