Skip to content

Commit

Permalink
✨ Add Code Scanning Tools Integration Page
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
gilday committed Mar 8, 2024
1 parent b1f81ab commit d5dd12d
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 3 deletions.
19 changes: 19 additions & 0 deletions docs/code-scanning-tool-fixes.md
Original file line number Diff line number Diff line change
@@ -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!
2 changes: 1 addition & 1 deletion docs/codemods/overview.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
---

# Core Codemods
Expand Down
2 changes: 1 addition & 1 deletion docs/faqs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
---

# FAQs
Expand Down
2 changes: 1 addition & 1 deletion docs/using-pixeebot.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 6
---

# User guide
Expand Down

0 comments on commit d5dd12d

Please sign in to comment.