Documentation Actions EnvironmentCheck - #22454
Open
knewbury01 wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Copilot review overview
Review tier: Balanced
Findings: 1
New issues introduced by this change (1)
| Severity | Finding |
|---|---|
 |
actions/ql/lib/codeql/actions/security/ControlChecks.qll — Correct the spelling of “vulnerabilities” in the new class documentation. This issue also appears… |
What changed in this PR
Documents how EnvironmentCheck treats deployment environments as configurable sanitizers.
Changes:
- Explains default and externally configured behavior.
- Documents disabling default sanitizer environments.
| File | Description |
|---|---|
actions/ql/lib/codeql/actions/security/ControlChecks.qll |
Adds EnvironmentCheck documentation. |
Suppressed comments (1)
actions/ql/lib/codeql/actions/security/ControlChecks.qll:287
- Correct the spelling of “sanitizer” in the description of the empty-model behavior.
* To create a default of "no default saniziter environment" one can add an
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+279
to
+289
| /** | ||
| * This type represents deployment environments that may serve as sanitizers for | ||
| * various vulnerabilities. | ||
| * | ||
| * It is possible to customize which deployment environments apply. The default behavior | ||
| * of this model is for any environment to be considered a sanitizer. | ||
| * If values are (currently manually/externally) provided in `actions/ql/lib/ext/config/deployment_environment.yml` | ||
| * then those names will be used to define the valid sanitizer set. | ||
| * To create a default of "no default saniziter environment" one can add an | ||
| * empty string to the data array in `deployment_environment.yml`. | ||
| */ |
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.
Improve documentation on actions/security/ControlChecks.qll EnvironmentCheck
currently was undocumented and as such its intended ways to use it could stand to be clarified
I dont think this needs a change note... but let me know if that is an incorrect assumption