@@ -62,49 +62,11 @@ In the code
6262
6363**Private ** GitHub repository
6464^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
65- .. note ::
66- As of 2025-07-29, these instructions have not been used. Thus, they should be
67- scrutinized and refined when they are used to configure a private repository.
68-
69- In GitHub
70- """""""""
71- A GitHub Admin will need to:
72-
73- #. Add the individual 'PRIVATE_SONAR_TOKEN' to the 'Organization secrets'
74- #. Activate the `exasonarqubeprchecks App <https://github.com/apps/exasonarqubeprchecks >`__
75- #. **Post-merge **: update the branch protections to include SonarQube analysis.
76-
77- * This should only be done when tests exist for the project, & that the project is
78- at a state in which enforced code coverage would not be a burden. If you do
79- not enact branch protections, it is recommended to create an issue to do so later.
80-
81- In Sonar
82- """"""""
83- An IT Admin will need to:
84-
85- #. Create a project on https://sonar.exasol.com
86-
87- * Project key should follow this pattern, e.g. ``com.exasol:python-toolbox ``
88-
89-
90- In the code
91- """""""""""
92- #. Specify in the ``noxconfig.py `` the relative path to the project's source code in ``Config.source ``
93- .. code-block :: python
94-
95- source: Path = Path(" exasol/<source-directory>" )
96-
97- #. Add the following to the project's file ``pyproject.toml ``
98- .. code-block :: toml
99-
100- [tool.sonar]
101- projectKey = "com.exasol:<project-key>"
102- host.url = "https://sonar.exasol.com"
103- organization = "exasol"
104- exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
65+ See the company wiki for details on how to use Exasol's on-prem SonarQube cluster
66+ and the needed steps to configure for a private GitHub repository.
10567
10668.. note ::
107- For more information, see the :ref: `General remarks <configuration_general_remarks >` section.
69+ For more general information, see the :ref: `General remarks <configuration_general_remarks >` section.
10870
10971.. _Exasol Way : https://sonarcloud.io/organizations/exasol/quality_gates/show/AXxvLH-3BdtLlpiYmZhh
11072.. _Sonar Matching Patterns : https://docs.sonarsource.com/sonarqube-server/project-administration/adjusting-analysis/setting-analysis-scope/defining-matching-patterns
0 commit comments