From d5dd12da68bdf26a18dfaf7d322f89bfd6b071a8 Mon Sep 17 00:00:00 2001 From: Johnathan Gilday Date: Fri, 8 Mar 2024 09:59:56 -0500 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Add=20Code=20Scanning=20Tools=20Int?= =?UTF-8?q?egration=20Page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Documents how to integrate Pixeebot with Sonar. It doesn't feel right to only have one tool on this page, so I mentioned that CodeQL is "coming soon". Practically, we have CodeQL integration by ways of GitHub Advanced Security right now, and documenting this is the subject of another task we will get to next week. --- docs/code-scanning-tool-fixes.md | 19 +++++++++++++++++++ docs/codemods/overview.md | 2 +- docs/faqs.md | 2 +- docs/using-pixeebot.md | 2 +- 4 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/code-scanning-tool-fixes.md diff --git a/docs/code-scanning-tool-fixes.md b/docs/code-scanning-tool-fixes.md new file mode 100644 index 0000000..ebf0a0d --- /dev/null +++ b/docs/code-scanning-tool-fixes.md @@ -0,0 +1,19 @@ +--- +sidebar_position: 4 +--- + +# Code Scanning Tool Fixes + +Pixeebot automatically fixes issues detected by code scanning tools when synced with the results of those scans. This page explains how to integrate code scanning tools with Pixeebot, so that Pixeebot may fix the issues those tools find. + +## Sonar + +Pixeebot fixes issues detected by Sonar when repositories have both the Pixeebot and Sonar GitHub Apps installed. + +For public repositories using SonarCloud, Pixeebot retrieves results from sonarcloud.io automatically with no further configuration required from the user. + +For private repositories using SonarCloud, use the [pixee/upload-tool-results-action](https://github.com/pixee/upload-tool-results-action) GitHub Action to synchronize SonarCloud findings with Pixeebot. + +## CodeQL + +Coming soon! diff --git a/docs/codemods/overview.md b/docs/codemods/overview.md index 4d3c649..c8326c8 100644 --- a/docs/codemods/overview.md +++ b/docs/codemods/overview.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 --- # Core Codemods diff --git a/docs/faqs.md b/docs/faqs.md index 55c432c..f4df150 100644 --- a/docs/faqs.md +++ b/docs/faqs.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 --- # FAQs diff --git a/docs/using-pixeebot.md b/docs/using-pixeebot.md index b43c213..9d110a4 100644 --- a/docs/using-pixeebot.md +++ b/docs/using-pixeebot.md @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 6 --- # User guide