Skip to content

Commit

Permalink
feat: CodeQL FAQ entry (#157)
Browse files Browse the repository at this point in the history
* feat: add faq about CodeQL

* fix: add link to existing CodeQL page

* fix: correct relative link

* fix: formatting
  • Loading branch information
bdoyal authored Mar 25, 2024
1 parent d98c020 commit 24c8fba
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions docs/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,14 @@ Each party agrees to hold data and confidential information of the other party i

Pixeebot works directly with your repositories in GitHub through pull requests, so you decide when and if you want to accept changes suggested by Pixeebot. You can find suggestions made by Pixeebot in the [Pixeebot Dashboard](https://app.pixee.ai/) as well as your repository's GitHub.com pull requests page. Also, Pixeebot [cryptographically signs every commit](https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work), which means changes suggested by Pixeebot are guaranteed to have come from Pixeebot, were not modified after the fact and are [verified by GitHub](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification).

### Where can I learn more and discuss Pixeebot?
### Does Pixeebot work with CodeQL?

Users can join the Pixee community [on Slack](https://join.slack.com/t/openpixee/shared_invite/zt-1pnk7jqdd-kfwilrfG7Ov4M8rorfOnUA). This channel can be used to engage with peers who are also interested in Pixee. Feel free to email us at [email protected] with any questions or comments.
Yes! Pixeebot can help you address issues discovered by [CodeQL](https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql) and [GitHub Advanced Security](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security). For the best results, use the [GitHub provided action](https://github.com/github/codeql-action) to trigger CodeQL analysis against your default branch and Pixeebot will take it from there. If CodeQL discovers issues Pixeebot can fix, you'll see a pull request from Pixeebot with suggested changes to your code. Check out our [docs page](code-scanning-tools/codeql) for more information about the types of CodeQL findings Pixeebot can fix.

### How can I apply automatic formatting to PRs generated by Pixeebot?

See our [Configuration](configuring.md#configuring-automatic-formatting) page for more information on how to enable automatic formatting of PRs generated by Pixeebot.

### Where can I learn more and discuss Pixeebot?

Users can join the Pixee community [on Slack](https://join.slack.com/t/openpixee/shared_invite/zt-1pnk7jqdd-kfwilrfG7Ov4M8rorfOnUA). This channel can be used to engage with peers who are also interested in Pixee. Feel free to email us at [email protected] with any questions or comments.

0 comments on commit 24c8fba

Please sign in to comment.