📖 docs: expand SAST check description to list all detected tools#5040
Open
venkatapgummadi wants to merge 1 commit into
Open
📖 docs: expand SAST check description to list all detected tools#5040venkatapgummadi wants to merge 1 commit into
venkatapgummadi wants to merge 1 commit into
Conversation
The SAST check (checks/raw/sast.go) detects CodeQL, SonarCloud/SonarQube, Snyk, Pysa, and Qodana, but the description in checks.yaml only mentions CodeQL and SonarCloud. The description also notes LGTM is awaiting its 'forthcoming shutdown,' but LGTM was sunset in December 2022. This commit updates the description to enumerate all five currently-detected SAST tools with their specific detection mechanisms (workflow action names or GitHub app slugs), corrects the LGTM status, and adds a remediation alternative for projects that cannot use CodeQL. Both checks.yaml and the auto-generated docs/checks.md are updated together per CONTRIBUTING.md. Signed-off-by: Venkata Pavan Kumar Gummadi <[email protected]>
|
This pull request has been marked stale because it has been open for 10 days with no activity |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The SAST check (
checks/raw/sast.go) detects CodeQL, SonarCloud/SonarQube, Snyk, Pysa, and Qodana, but the description inchecks.yamlonly mentions CodeQL and SonarCloud. The description also notes LGTM is awaiting its "forthcoming shutdown," but LGTM was sunset in December 2022. This commit updates the description to enumerate all five currently-detected SAST tools with their specific detection mechanisms (workflow action names or GitHub app slugs), corrects the LGTM status, and adds a remediation alternative for projects that cannot use CodeQL. Bothchecks.yamland the auto-generateddocs/checks.mdare updated together perCONTRIBUTING.md.What kind of change does this PR introduce?
Documentation update — no code changes.
What is the current behavior?
The SAST check description in
docs/checks/internal/checks.yamlmentions only CodeQL and SonarCloud as detected SAST tools, even thoughchecks/raw/sast.goalso detects Snyk (snyk/actions/*), Pysa (facebook/pysa-action), and Qodana (JetBrains/qodana-action). The description also states LGTM is "awaiting its forthcoming shutdown," but LGTM was sunset in December 2022 — that wording has been stale for over three years.What is the new behavior (if this is a feature change)?
The description now enumerates all five SAST tools the check detects, each with its specific detection mechanism:
github/codeql-action/analyze;github-code-scanningGitHub app on recent PRs<sonar.host.url>inpom.xml;sonarcloud/sonarqubecloudGitHub appssnyk/actions/*facebook/pysa-actionJetBrains/qodana-actionlgtm-comGitHub app (sunset Dec 2022, no usable signal)The LGTM language is corrected to reflect that the service is sunset. A remediation alternative is added listing the other four detected SAST integrations as fallback options for projects where CodeQL is not suitable.
(Documentation-only change — no test additions required.)
Which issue(s) this PR fixes
NONE
Special notes for your reviewer
checks/raw/sast.goor any other Go source. This PR aligns the user-facing documentation with what the existing detection logic already does.docs/checks/internal/checks.yamland the auto-generateddocs/checks.mdwere updated together, per the guidance inCONTRIBUTING.md.-sflag).Does this PR introduce a user-facing change?
Yes — readers of
docs/checks.mdand the website-rendered checks page will see updated SAST documentation. No changes to scoring or check behavior; only documentation.