diff --git a/.github/actions/security-issues/action.yml b/.github/actions/security-issues/action.yml index 42af5f295..bf1778c1b 100644 --- a/.github/actions/security-issues/action.yml +++ b/.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 diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 37a7c4983..3e9036e7c 100644 --- a/.github/workflows/checks.yml +++ b/.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 diff --git a/.github/workflows/merge-gate.yml b/.github/workflows/merge-gate.yml index c8caddfd5..dc57b3599 100644 --- a/.github/workflows/merge-gate.yml +++ b/.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 diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md index 8586564d0..5dae0f868 100644 --- a/doc/changes/changelog.md +++ b/doc/changes/changelog.md @@ -1,6 +1,7 @@ # Changelog * [unreleased](unreleased.md) +* [5.1.0](changes_5.1.0.md) * [5.0.0](changes_5.0.0.md) * [4.0.1](changes_4.0.1.md) * [4.0.0](changes_4.0.0.md) @@ -55,6 +56,7 @@ hidden: --- unreleased +changes_5.1.0 changes_5.0.0 changes_4.0.1 changes_4.0.0 diff --git a/doc/changes/changes_5.1.0.md b/doc/changes/changes_5.1.0.md new file mode 100644 index 000000000..4b1bff16b --- /dev/null +++ b/doc/changes/changes_5.1.0.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` diff --git a/doc/changes/unreleased.md b/doc/changes/unreleased.md index 11163776b..fb4737052 100644 --- a/doc/changes/unreleased.md +++ b/doc/changes/unreleased.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 diff --git a/doc/user_guide/features/metrics/sonar.rst b/doc/user_guide/features/metrics/sonar.rst index 91db1cfe5..78281f0df 100644 --- a/doc/user_guide/features/metrics/sonar.rst +++ b/doc/user_guide/features/metrics/sonar.rst @@ -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 `__ -#. **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/") - -#. Add the following to the project's file ``pyproject.toml`` - .. code-block:: toml - - [tool.sonar] - projectKey = "com.exasol:" - host.url = "https://sonar.exasol.com" - organization = "exasol" - exclusions = "/version.py,//*" +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 ` section. + For more general information, see the :ref:`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 diff --git a/exasol/toolbox/templates/github/workflows/checks.yml b/exasol/toolbox/templates/github/workflows/checks.yml index 231ada753..c6e451782 100644 --- a/exasol/toolbox/templates/github/workflows/checks.yml +++ b/exasol/toolbox/templates/github/workflows/checks.yml @@ -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 diff --git a/exasol/toolbox/templates/github/workflows/merge-gate.yml b/exasol/toolbox/templates/github/workflows/merge-gate.yml index bb54e2b94..e1c2174a3 100644 --- a/exasol/toolbox/templates/github/workflows/merge-gate.yml +++ b/exasol/toolbox/templates/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: "(( os_version ))" permissions: contents: read diff --git a/exasol/toolbox/version.py b/exasol/toolbox/version.py index a1392f5a6..5452203e7 100644 --- a/exasol/toolbox/version.py +++ b/exasol/toolbox/version.py @@ -9,7 +9,7 @@ """ MAJOR = 5 -MINOR = 0 +MINOR = 1 PATCH = 0 VERSION = f"{MAJOR}.{MINOR}.{PATCH}" __version__ = VERSION diff --git a/project-template/cookiecutter.json b/project-template/cookiecutter.json index 79925b560..a5f9fdada 100644 --- a/project-template/cookiecutter.json +++ b/project-template/cookiecutter.json @@ -9,7 +9,7 @@ "author_email": "opensource@exasol.com", "project_short_tag": "", "python_version_min": "3.10", - "exasol_toolbox_version_range": ">=5.0.0,<6", + "exasol_toolbox_version_range": ">=5.1.0,<6", "license_year": "{% now 'utc', '%Y' %}", "__repo_name_slug": "{{cookiecutter.package_name}}", "__package_name_slug": "{{cookiecutter.package_name}}", diff --git a/pyproject.toml b/pyproject.toml index dd37f49d3..65d080cc3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "exasol-toolbox" -version = "5.0.0" +version = "5.1.0" description = "Your one-stop solution for managing all standard tasks and core workflows of your Python project." authors = [ { name = "Nicola Coretti", email = "nicola.coretti@exasol.com" },