diff --git a/README.md b/README.md index 6e75e3f..5f6e4c9 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ -# GitHub Action: SonarQube Analysis +# GitHub Action: SonarQube Analysis for .NET + +Minimal implementation; ```yaml steps: -- uses: f2calv/gha-sonarqube@v1 +- uses: f2calv/gha-sonarqube-dotnet@v1 with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} - BuildConfiguration: Release ``` ## Inputs - GITHUB_TOKEN -- SONAR_TOKEN - this is optional, if the token isn't passed in then the action will post a warning but continue to completion. -- BuildConfiguration, `Debug` or `Release` +- SONAR_TOKEN - this is optional, if the token isn't passed in then the action will still execute run but will also post a warning and the critical SonarQube won't happen. +- _(optional)_ BuildConfiguration, `Debug` or `Release`