From d33d277696827e1d9548e6d2d4a4363e3394a8e0 Mon Sep 17 00:00:00 2001 From: Johnathan Gilday Date: Wed, 5 Jun 2024 16:57:49 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20SonarQube=20Article?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Help users understand that Pixeebot can fix SonarQube issues in addition to SonarCloud. --- docs/code-scanning-tools/codeql.md | 2 +- docs/code-scanning-tools/semgrep.md | 2 +- docs/code-scanning-tools/sonar.md | 22 +++++++++++++--------- docs/code-scanning-tools/sonarqube.md | 22 ++++++++++++++++++++++ 4 files changed, 37 insertions(+), 11 deletions(-) create mode 100644 docs/code-scanning-tools/sonarqube.md diff --git a/docs/code-scanning-tools/codeql.md b/docs/code-scanning-tools/codeql.md index 2bc46ca..b3b59ce 100644 --- a/docs/code-scanning-tools/codeql.md +++ b/docs/code-scanning-tools/codeql.md @@ -1,6 +1,6 @@ --- title: "CodeQL" -sidebar_position: 3 +sidebar_position: 4 --- # CodeQL diff --git a/docs/code-scanning-tools/semgrep.md b/docs/code-scanning-tools/semgrep.md index 4e6dab5..be5860d 100644 --- a/docs/code-scanning-tools/semgrep.md +++ b/docs/code-scanning-tools/semgrep.md @@ -1,6 +1,6 @@ --- title: "Semgrep" -sidebar_position: 2 +sidebar_position: 3 --- # Semgrep diff --git a/docs/code-scanning-tools/sonar.md b/docs/code-scanning-tools/sonar.md index 07a4cf5..b6b14bf 100644 --- a/docs/code-scanning-tools/sonar.md +++ b/docs/code-scanning-tools/sonar.md @@ -1,22 +1,26 @@ --- -title: "Sonar" +title: "SonarCloud" sidebar_position: 1 --- -# Sonar +# SonarCloud -Pixeebot can automatically fix issues detected by [Sonar](https://www.sonarsource.com/products/sonarcloud/). This page explains how to integrate your Sonar results with Pixeebot. +Pixeebot can automatically fix issues detected by [SonarCloud](https://www.sonarsource.com/products/sonarcloud/). This page explains how to integrate your SonarCloud results with Pixeebot. + +:::info +Looking to fix [SonarQube](https://www.sonarsource.com/products/sonarqube/) issues? See [SonarQube](./sonarqube.md) +::: ## How to Get Started -1. Install [pixeebot Github Application](https://github.com/marketplace/pixeebot-automated-code-fixes) -2. Install [Sonar Github Application](https://github.com/marketplace/sonarcloud) -3. Add [Upload Tool Results Github Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot) -4. Start receiving Pull Requests that address Sonar findings. +1. Install [Pixeebot GitHub Application](https://github.com/marketplace/pixeebot-automated-code-fixes) +2. Install [Sonar GitHub Application](https://github.com/marketplace/sonarcloud) +3. Add [Upload Tool Results GitHub Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot) +4. Start receiving Pull Requests from Pixeebot that address Sonar findings. -## More information +## More Information -Pixeebot fixes issues detected by Sonar when repositories have both the Pixeebot and Sonar GitHub Apps installed. +Pixeebot fixes issues detected by SonarCloud when repositories have both the Pixeebot and SonarCloud GitHub Apps installed. For public repositories using SonarCloud, Pixeebot retrieves results from sonarcloud.io automatically with no further configuration required from the user. diff --git a/docs/code-scanning-tools/sonarqube.md b/docs/code-scanning-tools/sonarqube.md new file mode 100644 index 0000000..04c09e8 --- /dev/null +++ b/docs/code-scanning-tools/sonarqube.md @@ -0,0 +1,22 @@ +--- +title: "SonarQube" +sidebar_position: 2 +--- + +# SonarQube + +Pixeebot can automatically fix issues detected by [SonarQube](https://www.sonarsource.com/products/sonarqube/). + +For a given Sonar rule, Pixeebot's fixes are the same, regardless of whether the issue was detected by either SonarCloud or SonarQube. However, the steps required to integrate Pixeebot with these systems is different. + +## How to Get Started + +1. Install [Pixeebot GitHub Application](https://github.com/marketplace/pixeebot-automated-code-fixes) +2. Add [Upload Tool Results GitHub Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot) to workflows that run SonarQube analysis. +3. Start receiving Pull Requests from Pixeebot that address Sonar findings. + +## More Information + +SonarQube Community Edition lacks the features necessary to integrate with Pixeebot's PR experience. + +