@@ -201,25 +201,26 @@ We also need to configure settings for github-pages environment:
201201
2022028. Set up for Sonar
203203+++++++++++++++++++
204- We use SonarQube Cloud to analyze, visualize, & track linting, security, & coverage. In
205- order to properly set it up, you'll need to do the following instructions for each **public ** project.
206- At this time, we do not currently support setting up SonarQube for a **private ** project.
204+ PTB supports using SonarQube Cloud to analyze, visualize, & track linting, security, &
205+ coverage. In order to properly set it up, you'll need to do the following instructions
206+ for each **public ** project. At this time, PTB currently does not support setting up
207+ SonarQube for a **private ** project.
207208
208- 1. specify in the `noxconfig.py ` the relative path to the project's source code in `Config.source `
209+ 1. Specify in the `noxconfig.py ` the relative path to the project's source code in `Config.source `
209210 .. code-block :: python
210211
211212 source: Path = Path(" exasol/toolbox" )
212- 2. add the 'SONAR_TOKEN' to the 'Organization secrets'
213- 3. activate the SonarQubeCloud App
214- 4. create a project on SonarCloud
215- 5. add the following information to the project's `pyproject.toml `
213+ 2. Add the 'SONAR_TOKEN' to the 'Organization secrets' in GitHub (this requires a person being a GitHub organization owner).
214+ 3. Activate the SonarQubeCloud App
215+ 4. Create a project on SonarCloud
216+ 5. Add the following information to the project's file `pyproject.toml `
216217 .. code-block :: toml
217218
218219 [tool.sonar]
219220 projectKey = "com.exasol:<project-key>"
220221 hostUrl = "https://sonarcloud.io"
221222 organization = "exasol"
222- 6. post -merge, update the branch protections to include SonarQube analysis
223+ 6. Post -merge, update the branch protections to include SonarQube analysis
223224
224225
225226
0 commit comments