Commit dd9eb2e2 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: fix SonarQube links

parent 4da09ee2
Loading
Loading
Loading
Loading
+8 −8
Original line number Diff line number Diff line
@@ -71,7 +71,7 @@ In order to implement the best GitLab and SonarQube integration, the .NET templa
- Unit Tests report for [GitLab integration](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsjunit) is generated with [JUnit Test Logger](https://github.com/spekt/junit.testlogger)
    
  :information_source: the `JunitXml.TestLogger` package shall be added to your test projects ([see nuget](https://www.nuget.org/packages/JUnitXml.TestLogger))
- Unit Tests report for [SonarQube integration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/test-execution-parameters/#sonarcsxunitreportspaths) is generated with [Xunit Test Logger](https://github.com/spekt/xunit.testlogger) 
- Unit Tests report for [SonarQube integration](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/test-coverage/test-execution-parameters/#sonarcsxunitreportspaths) is generated with [Xunit Test Logger](https://github.com/spekt/xunit.testlogger) 
    
  :information_source: the `XunitXml.TestLogger` package shall be added to your test projects ([see nuget](https://www.nuget.org/packages/XunitXml.TestLogger))

@@ -85,9 +85,9 @@ With those packages properly configured, the following reports are generated:
| Report         | Format                                                                       | Usage             |
| -------------- | ---------------------------------------------------------------------------- | ----------------- |
| `reports/dotnet-test.junit.xml` | [JUnit](https://en.wikipedia.org/wiki/XUnit) test report(s) | [GitLab integration](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsjunit) |
| `reports/dotnet-test.xunitnet.xml` | [xUnit.net v2](https://xunit.net/docs/format-xml-v2) test report(s) | [SonarQube integration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/test-execution-parameters/#sonarcsxunitreportspaths) |
| `reports/dotnet-test.xunitnet.xml` | [xUnit.net v2](https://xunit.net/docs/format-xml-v2) test report(s) | [SonarQube integration](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/test-coverage/test-execution-parameters/#sonarcsxunitreportspaths) |
| `reports/coverage.cobertura.xml` | [Cobertura XML](https://gcovr.com/en/stable/output/cobertura.html) coverage report | [GitLab integration](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportscoverage_report) |
| `reports/coverage.opencover.xml` | [OpenCover](https://github.com/OpenCover/opencover/wiki) coverage report | [SonarQube integration](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/dotnet-test-coverage/#opencover) |
| `reports/coverage.opencover.xml` | [OpenCover](https://github.com/OpenCover/opencover/wiki) coverage report | [SonarQube integration](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/test-coverage/dotnet-test-coverage/#opencover) |

### `dotnet-sonar` job

@@ -98,14 +98,14 @@ It uses the following variable:
| Input / Variable      | Description                              | Default value     |
| --------------------- | ---------------------------------------- | ----------------- |
| `sonar-host-url` / `SONAR_HOST_URL` | SonarQube server url                   | _none_ (disabled) |
| :lock: `SONAR_TOKEN`     | SonarQube authentication [token](https://docs.sonarsource.com/sonarqube-server/latest/user-guide/managing-tokens/#using-a-token) (depends on your authentication method) | _none_ |
| `sonar-extra-args` / `DOTNET_SONAR_EXTRA_ARGS`      | Extra arguments used by the [SonarScanner](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/scanners/dotnet/using/#analysis-steps)          | _none_ |
| :lock: `SONAR_TOKEN`     | SonarQube authentication [token](https://docs.sonarsource.com/sonarqube-server/user-guide/managing-tokens/#using-a-token) (depends on your authentication method) | _none_ |
| `sonar-extra-args` / `DOTNET_SONAR_EXTRA_ARGS`      | Extra arguments used by the [SonarScanner](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/scanners/dotnet/using/#analysis-steps)          | _none_ |

More info:

* [dotnet language support](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/dotnet-test-coverage/)
* [test coverage](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/test-coverage-parameters/#csharp) & [test execution](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/test-execution-parameters/#csharp) parameters
* [external analyzer reports](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/importing-external-issues/external-analyzer-reports/#external-dotnet-issues)
* [dotnet language support](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/test-coverage/dotnet-test-coverage/)
* [test coverage](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/test-coverage/test-coverage-parameters/#csharp) & [test execution](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/test-coverage/test-execution-parameters/#csharp) parameters
* [external analyzer reports](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/importing-external-issues/external-analyzer-reports/#external-dotnet-issues)

### Secrets management

+3 −3
Original line number Diff line number Diff line
@@ -57,7 +57,7 @@
    {
      "id": "dotnet-sonar",
      "name": "dotnet sonar",
      "description": "[Dotnet Sonar](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/scanners/dotnet/using) analysis",
      "description": "[Dotnet Sonar](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/scanners/dotnet/using) analysis",
      "variables": [
        {
          "name": "SONAR_HOST_URL",
@@ -72,12 +72,12 @@
        },
        {
          "name": "SONAR_TOKEN",
          "description": "SonarQube authentication token (see https://docs.sonarsource.com/sonarqube-server/latest/user-guide/managing-tokens/) - depends on your authentication method",
          "description": "SonarQube authentication token (see https://docs.sonarsource.com/sonarqube-server/user-guide/managing-tokens/) - depends on your authentication method",
          "secret": true
        },
        {
          "name": "DOTNET_SONAR_EXTRA_ARGS",
          "description": "Extra arguments used by the [SonarScanner](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/scanners/dotnet/using/#analysis-steps)",
          "description": "Extra arguments used by the [SonarScanner](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/scanners/dotnet/using/#analysis-steps)",
          "advanced": true
        }
      ]
+2 −2
Original line number Diff line number Diff line
@@ -47,7 +47,7 @@ spec:
      description: SonarQube Project Key
      default: ''
    sonar-extra-args:
      description: Extra arguments used by the [SonarScanner](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/scanners/dotnet/using/#analysis-steps)
      description: Extra arguments used by the [SonarScanner](https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/scanners/dotnet/using/#analysis-steps)
      default: ''
---
# default workflow rules: Merge Request pipelines
@@ -501,7 +501,7 @@ dotnet-sonar:
    GIT_DEPTH: "0"  # Tells git to fetch all the branches of the project, required by the analysis task
  script:
    - dotnet tool install ${TRACE+--verbosity d} --tool-path $DOTNET_CLI_HOME/.dotnet/tools dotnet-sonarscanner
    # see: https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/test-coverage/dotnet-test-coverage/
    # see: https://docs.sonarsource.com/sonarqube-server/analyzing-source-code/test-coverage/dotnet-test-coverage/
    - |
      $DOTNET_CLI_HOME/.dotnet/tools/dotnet-sonarscanner begin ${TRACE+/d:sonar.verbose=true} \
        /k:"${SONAR_PROJECT_KEY}" \