sonarsource/sonarcloud-github-action
1
0
Fork 0
mirror of https://github.com/sonarsource/sonarcloud-github-action.git synced 2026-06-08 15:17:11 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clarifications about YAML snippet and GITHUB_TOKEN

Browse source
This commit is contained in:
Alix Lourme 2019-11-28 14:58:03 +01:00 • committed by Simon Brandhof
commit c3b609966b
1 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -24,14 +24,6 @@ sonar.projectKey=<replace with the key generated when setting up the project on
sonar.sources=. sonar.sources=.
``` ```
You can change the analysis base directory by using the optional input `projectBaseDir` like this:
```yaml
uses: sonarsource/sonarcloud-github-action@master
with:
projectBaseDir: my-custom-directory
```
The workflow, usually declared in `.github/workflows/build.yml`, looks like: The workflow, usually declared in `.github/workflows/build.yml`, looks like:
```yaml ```yaml
@ -50,9 +42,18 @@ jobs:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
``` ```
You can change the analysis base directory by using the optional input `projectBaseDir` like this:
```yaml
uses: sonarsource/sonarcloud-github-action@master
with:
projectBaseDir: my-custom-directory
```
### Secrets ### Secrets
- `SONAR_TOKEN` – **Required** this is the token used to authenticate access to SonarCloud. You can generate a token on your [Security page in SonarCloud](https://sonarcloud.io/account/security/). You can set the `SONAR_TOKEN` environment variable in the "Secrets" settings page of your repository. - `SONAR_TOKEN` – **Required** this is the token used to authenticate access to SonarCloud. You can generate a token on your [Security page in SonarCloud](https://sonarcloud.io/account/security/). You can set the `SONAR_TOKEN` environment variable in the "Secrets" settings page of your repository.
- *`GITHUB_TOKEN` – Provided by Github (see [Authenticating with the GITHUB_TOKEN](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token)).*
## Example of pull request analysis ## Example of pull request analysis