|
1 | 1 | --- |
2 | | -title: 'Next step: Sonarcloud integration' |
| 2 | +title: 'Action required: Sonarcloud integration' |
3 | 3 | labels: enhancement |
4 | 4 | --- |
5 | 5 |
|
6 | | -Continuous code quality can be handled by many services for `NLeSC/python-template` we chose [Sonarcloud](https://sonarcloud.io/). |
7 | | -[Sonarcloud](https://sonarcloud.io/) is used to perform quality analysis and code coverage report on each push. |
| 6 | +Continuous code quality can be handled by [Sonarcloud](https://sonarcloud.io/). This repository is configured to use Sonarcloud to perform quality analysis and code coverage report on each push. |
8 | 7 |
|
9 | | -Sonarcloud must be configured for the analysis to work |
| 8 | +In order to configure Sonarcloud analysis [GitHub Action workflow](.github/workflows/sonarcloud.yml) you must follow the steps below: |
10 | 9 |
|
11 | | -1. go to [Sonarcloud](https://sonarcloud.io/projects/create) |
12 | | -2. login with your GitHub account |
13 | | -3. add organization or reuse existing one |
14 | | -4. set up repository |
15 | | -5. go to [new code definition administration page](https://sonarcloud.io/project/new_code?id={{ cookiecutter.github_organization }}_{{ cookiecutter.project_name }}) and select `Number of days` option |
16 | | - |
17 | | -The analysis will be run by [GitHub Action workflow](.github/workflows/sonarcloud.yml) |
18 | | -To be able to run the analysis, a token must be created at [Sonarcloud account](https://sonarcloud.io/account/security/) and this token must be added as `SONAR_TOKEN` to [secrets on GitHub](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_name }}/settings/secrets/actions) |
| 10 | +1. go to [Sonarcloud](https://sonarcloud.io/projects/create) to create a new Sonarcloud project |
| 11 | +1. login with your GitHub account |
| 12 | +1. add Sonarcloud organization or reuse existing one |
| 13 | +1. set up a repository |
| 14 | +1. go to [new code definition administration page](https://sonarcloud.io/project/new_code?id={{ cookiecutter.github_organization }}_{{ cookiecutter.project_name }}) and select `Number of days` option |
| 15 | +1. To be able to run the analysis: |
| 16 | + 1. a token must be created at [Sonarcloud account](https://sonarcloud.io/account/security/) |
| 17 | + 1. the created token must be added as `SONAR_TOKEN` to [secrets on GitHub](https://github.com/{{ cookiecutter.github_organization }}/{{ cookiecutter.project_name }}/settings/secrets/actions) |
0 commit comments