Skip to content

Commit 0323732

Browse files
committed
Improve documentation on actions/security/ControlChecks.qll EnvironmentCheck
1 parent 9567f1a commit 0323732

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

actions/ql/lib/codeql/actions/security/ControlChecks.qll

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,9 +276,19 @@ abstract class LabelCheck extends ControlCheck {
276276
}
277277
}
278278

279+
/**
280+
* This type represents deployment environments that may serve as sanitizers for
281+
* various vunlerabilities.
282+
*
283+
* It is possible to customize which deployment environments apply. The default behavior
284+
* of this model is for any environment to be considered a sanitizer.
285+
* If values are (currently manually/externally) provided in `actions/ql/lib/ext/config/deployment_environment.yml`
286+
* then those names will be used to define the valid sanitizer set.
287+
* To create a default of "no default saniziter environment" one can add an
288+
* empty string to the data array in `deployment_environment.yml`.
289+
*/
279290
class EnvironmentCheck extends ControlCheck instanceof Environment {
280291
EnvironmentCheck() {
281-
// if there are any custom tuples use those
282292
if enabledDeploymentEnvironmentDataModel(_)
283293
then enabledDeploymentEnvironmentDataModel(this.(Environment).getName())
284294
else this instanceof Environment

0 commit comments

Comments
 (0)