From 002f549fb2fb71a35a7f08767a02893fd2136392 Mon Sep 17 00:00:00 2001 From: GavinMeierSonos Date: Thu, 7 Mar 2024 10:06:25 -0600 Subject: [PATCH] Add section in readme about the changes I made --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e133687..71913f8 100644 --- a/README.md +++ b/README.md @@ -106,14 +106,25 @@ More information about possible analysis parameters can be found in [the documen - `SONAR_HOST_URL` – **Required** this tells the scanner where SonarQube is hosted. You can set the `SONAR_HOST_URL` environment variable in the "Secrets" settings page of your repository, or you can add them at the level of your GitHub organization (recommended). - `SONAR_ROOT_CERT` – Holds an additional root certificate (in PEM format) that is used to validate the SonarQube server certificate. You can set the `SONAR_ROOT_CERT` environment variable in the "Secrets" settings page of your repository, or you can add them at the level of your GitHub organization (recommended). +### Alternative base image + +You can pass in the baseImage input argument to allow for a different base image to be used with the action. The primary use case for this is if you are experiencing rate limiting from the docker registry. + +```yaml +- name: SonarQube Scan + uses: sonarsource/sonarqube-scan-action@master + with: + baseImage: dockerhub-remote.artifactory.mystuff.com/sonarsource/sonar-scanner-cli:5.0.1 +``` + ## Alternatives for Java, .NET, and C/C++ projects This GitHub Action will not work for all technologies. If you are in one of the following situations, you should use the following alternatives: -* Your code is built with Maven. Read the documentation about our [Scanner for Maven](https://redirect.sonarsource.com/doc/install-configure-scanner-maven.html). -* Your code is built with Gradle. Read the documentation about our [Scanner for Gradle](https://redirect.sonarsource.com/doc/gradle.html). -* You want to analyze a .NET solution. Read the documentation about our [Scanner for .NET](https://redirect.sonarsource.com/doc/install-configure-scanner-msbuild.html). -* You want to analyze C/C++ code. Read the documentation on [analyzing C/C++ code](https://docs.sonarqube.org/latest/analysis/languages/cfamily/). +- Your code is built with Maven. Read the documentation about our [Scanner for Maven](https://redirect.sonarsource.com/doc/install-configure-scanner-maven.html). +- Your code is built with Gradle. Read the documentation about our [Scanner for Gradle](https://redirect.sonarsource.com/doc/gradle.html). +- You want to analyze a .NET solution. Read the documentation about our [Scanner for .NET](https://redirect.sonarsource.com/doc/install-configure-scanner-msbuild.html). +- You want to analyze C/C++ code. Read the documentation on [analyzing C/C++ code](https://docs.sonarqube.org/latest/analysis/languages/cfamily/). ## Have questions or feedback?