-
Notifications
You must be signed in to change notification settings - Fork 1
🌆 Retire Find-and-Fix Changes #211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
60cdb90
🔥 Remove Content that References Find-and-Fix
gilday 67a5e70
✨ Add Semgrep OSS Example
gilday ddba0aa
add public repo starter page
nahsra a4b860f
fix semgrep docs
nahsra 2fdbf8e
fix numbering
nahsra c8aa62c
Merge branch 'main' into retire-find-and-fix
nahsra 329dff6
prettier
nahsra b02fb91
Update installing.md
sip49 93cd589
Update running_on_public_github_repos.md
sip49 b852124
prettier
nahsra File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| # For public repositories without tools | ||
|
|
||
| This page describes how to help set up Pixee on a public GitHub repository that doesn't have any tools configured yet. Note that some features are only available in our enterprise offering. | ||
|
|
||
| ## Step 1: Choose and set up your repository | ||
|
|
||
| On the repository you want to secure, enable GitHub _Issues_ so you can see the Pixee dashboard. You can always disable this later if, after you review, you prefer using our dashboard. | ||
|
|
||
| 1. In your repository, go to `Settings` > `General`. | ||
| 2. Under the `Features`, select `Issues`. | ||
|
|
||
| ## Step 2: Choose CodeQL or SonarQube Cloud | ||
|
|
||
| For ease of integration, we suggest picking either CodeQL (through GitHub Advanced Security) or SonarQube Cloud. Both can be used to find vulnerabilities in your code, are free for public repositories, and offer simple onboarding. CodeQL is more focused on security than quality, but Sonar has a large rule based and is trusted by developers all over the world. Both are great choices. | ||
|
|
||
| ### SonarQube Cloud | ||
|
|
||
| [Follow these instructions](https://docs.sonarsource.com/sonarqube-cloud/getting-started/github/) for installing SonarQube Cloud (to make things easier, login with your GitHub identity). | ||
|
|
||
| ### CodeQL through GitHub Advanced Security (GHAS) | ||
|
|
||
| 1. In your repository, go to `Settings` > `Code Security`. | ||
| 2. Under the `Tools` > `CodeQL analysis`, hit `Set up`, then `Default`. | ||
|
|
||
| You may want to wait until the first scan finishes before moving onto the next step. You can see when it finishes by going to `Actions` and watching the progress of the recently-run CodeQL job. | ||
|
|
||
| ## Step 3: Install Pixeebot | ||
|
|
||
| With the tool properly configured, the next step is to install Pixee. | ||
|
|
||
| 1. Go to our [GitHub App page](https://github.com/apps/pixeebot/). | ||
| 2. Click `Install` (or `Configure`) and follow the prompts from GitHub. You'll be directed to your Pixee dashboard once the installation process is complete. | ||
|
|
||
| ## Step 4: See fixes available | ||
|
|
||
| 1. Wait a few minutes for Pixee to process the results associated with the default branch. | ||
| 2. There should be a new issue that shows which fixes are currently available. | ||
|
|
||
| import IssueDashboard from '/img/issue-dashboard.png'; | ||
|
|
||
| <img src={IssueDashboard} alt="Issue dashboard" style={{width: 400}} /> | ||
|
|
||
| You can use this dashboard to see what fixes are available, coming soon or summon Pixee to issue the fixes. | ||
|
|
||
| > Note: This GitHub-led experience will only show output from our AutoTriage AI agent when you make PRs that have security issues. To take advantage of this feature at scale, [contact us](https://pixee.ai/demo-landing-page)! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.