paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 28 Packages Projects Releases Wiki Activity

docs(sonarqube): enhance token content documentation

Browse Source 
Signed-off-by: Dominik Schwank <dominik.schwank@sda.se>
This commit is contained in:
Dominik Schwank
2022-01-11 17:49:32 +01:00
parent 0d1e0bef8e
commit 3423b3b24d
2 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/itchy-walls-count.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-sonarqube': patch
---
Enhance token description by highlighting that the trailing colon is required.
plugins/sonarqube/README.md
+5 -2
View File
@@ -36,7 +36,8 @@ yarn add @backstage/plugin-sonarqube
3. Add the proxy config:
Provide a method for your Backstage backend to get to your SonarQube API end point. Add configuration to your `app-config.yaml` file depending on the product you use.
Provide a method for your Backstage backend to get to your SonarQube API end point. Add configuration to your `app-config.yaml` file depending on the product you use. Make sure to keep the trailing colon after the `SONARQUBE_TOKEN`, it is required to call
the Web API (see [docs](https://docs.sonarqube.org/latest/extend/web-api/)).
**SonarCloud**
@@ -45,6 +46,7 @@ proxy:
'/sonarqube':
target: https://sonarcloud.io/api
allowedMethods: ['GET']
# note that the colon after the token is required
auth: '${SONARQUBE_TOKEN}:'
# Environmental variable: SONARQUBE_TOKEN
# Fetch the sonar-auth-token from https://sonarcloud.io/account/security/
@@ -57,6 +59,7 @@ proxy:
'/sonarqube':
target: https://your.sonarqube.instance.com/api
allowedMethods: ['GET']
# note that the colon after the token is required
auth: '${SONARQUBE_TOKEN}:'
# Environmental variable: SONARQUBE_TOKEN
# Fetch the sonar-auth-token from https://sonarcloud.io/account/security/
@@ -65,7 +68,7 @@ sonarQube:
baseUrl: https://your.sonarqube.instance.com
```
4. Get and provide `SONARQUBE_TOKEN` as an env variable (https://sonarcloud.io/account/security or https://docs.sonarqube.org/latest/user-guide/user-token/)
4. Get and provide `SONARQUBE_TOKEN` as an env variable (https://sonarcloud.io/account/security or https://docs.sonarqube.org/latest/user-guide/user-token/).
5. Run the following commands in the root folder of the project to install and compile the changes.