You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning.md
+3-24Lines changed: 3 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -296,8 +296,6 @@ In this example, the default queries will be run for Java, as well as the querie
296
296
297
297
{% data reusables.code-scanning.run-additional-queries %}
298
298
299
-
{% ifversion codeql-packs %}
300
-
301
299
### Using query packs
302
300
303
301
To add one or more {% data variables.product.prodname_codeql %} query packs, add a `with: packs:` entry within the `uses: {% data reusables.actions.action-codeql-action-init %}` section of the workflow. Within `packs` you specify one or more packages to use and, optionally, which version to download. Where you don't specify a version, the latest version is downloaded. If you want to use packages that are not publicly available, you need to set the `GITHUB_TOKEN` environment variable to a secret that has access to the packages. For more information, see "[AUTOTITLE](/actions/security-guides/automatic-token-authentication)" and "[AUTOTITLE](/actions/security-guides/encrypted-secrets)."
@@ -321,7 +319,6 @@ In the example below, `scope` is the organization or personal account that publi
**Note:** If you specify a particular version of a query pack to use,
@@ -334,7 +331,6 @@ To ensure optimal performance, if you need to specify exact query pack versions,
334
331
For more information about pack compatibility, see "[AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/publishing-and-using-codeql-packs#about-codeql-pack-compatibility)."
335
332
336
333
{% endnote %}
337
-
{% endif %}
338
334
339
335
### Downloading {% data variables.product.prodname_codeql %} packs from {% data variables.product.prodname_ghe_server %}
340
336
@@ -370,7 +366,6 @@ Notice the `|` after the `registries` property name. This is important since {%
370
366
371
367
### Using queries in QL packs
372
368
373
-
{% endif %}
374
369
To add one or more queries, add a `with: queries:` entry within the `uses: {% data reusables.actions.action-codeql-action-init %}` section of the workflow. If the queries are in a private repository, use the `external-repository-token` parameter to specify a token that has access to checkout the private repository.
375
370
376
371
You can also specify query suites in the value of `queries`. Query suites are collections of queries, usually grouped by purpose or language.
@@ -388,24 +383,18 @@ You can also specify query suites in the value of `queries`. Query suites are co
388
383
389
384
{% data reusables.code-scanning.codeql-query-suites-explanation %}
390
385
391
-
{% ifversion codeql-packs %}
392
-
393
386
### Working with custom configuration files
394
387
395
-
{% endif %}
396
-
397
-
If you also use a configuration file for custom settings, any additional {% ifversion codeql-packs %}packs or {% endif %}queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional {% ifversion codeql-packs %}packs or {% endif %}queries, prefix the value of {% ifversion codeql-packs %}`packs` or {% endif %}`queries` in the workflow with the `+` symbol. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)."
388
+
If you also use a configuration file for custom settings, any additional packs or queries specified in your workflow are used instead of those specified in the configuration file. If you want to run the combined set of additional packs or queries, prefix the value of `packs` or `queries` in the workflow with the `+` symbol. For more information, see "[Using a custom configuration file](#using-a-custom-configuration-file)."
398
389
399
-
In the following example, the `+` symbol ensures that the specified additional {% ifversion codeql-packs %}packs and {% endif %}queries are used together with any specified in the referenced configuration file.
390
+
In the following example, the `+` symbol ensures that the specified additional packs and queries are used together with any specified in the referenced configuration file.
400
391
401
392
``` yaml copy
402
393
- uses: {% data reusables.actions.action-codeql-action-init %}
<!-- Anchor to maintain the current CodeQL CLI manual pages link: https://aka.ms/code-scanning-docs/config-file -->
411
400
<a name="using-a-custom-configuration-file"></a>
@@ -415,7 +404,7 @@ In the following example, the `+` symbol ensures that the specified additional {
415
404
416
405
## Using a custom configuration file
417
406
418
-
A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries{% ifversion code-scanning-exclude-queries-from-analysis %}, exclude or include specific queries,{% endif %} and to specify which directories to scan during analysis.
407
+
A custom configuration file is an alternative way to specify additional packs and queries to run. You can also use the file to disable the default queries, exclude or include specific queries, and to specify which directories to scan during analysis.
419
408
420
409
In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_.
421
410
@@ -437,8 +426,6 @@ If the configuration file is located in an external private repository, use the
437
426
438
427
The settings in the configuration file are written in YAML format.
439
428
440
-
{% ifversion codeql-packs %}
441
-
442
429
### Specifying {% data variables.product.prodname_codeql %} query packs
443
430
444
431
You specify {% data variables.product.prodname_codeql %} query packs in an array. Note that the format is different from the format used by the workflow file.
@@ -482,7 +469,6 @@ packs:
482
469
```
483
470
484
471
{% endraw %}
485
-
{% endif %}
486
472
487
473
{% ifversion codeql-threat-models %}
488
474
@@ -511,8 +497,6 @@ Optionally, you can give each array element a name, as shown in the example conf
511
497
512
498
If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`.
You can add `exclude` and `include` filters to your custom configuration file, to specify the queries you want to exclude or include in the analysis.
@@ -546,8 +530,6 @@ You can find another example illustrating the use of these filters in the "[Exam
546
530
547
531
For more information about using `exclude` and `include` filters in your custom configuration file, see "[AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites#filtering-the-queries-in-a-query-suite)." For information on the query metadata you can filter on, see "[Metadata for CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/)."
548
532
549
-
{% endif %}
550
-
551
533
### Specifying directories to scan
552
534
553
535
When codebases are analyzed without building the code, you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can also exclude the files in specific directories from analysis by adding a `paths-ignore` array. You can use this option when you run the {% data variables.product.prodname_codeql %} actions on an interpreted language (Python, Ruby, and JavaScript/TypeScript){% ifversion codeql-no-build %} or when you analyze a compiled language without building the code (currently supported for {% data variables.code-scanning.no_build_support %}){% endif %}.
@@ -578,8 +560,6 @@ You can quickly analyze small portions of a monorepo when you modify code in spe
578
560
579
561
{% data reusables.code-scanning.example-configuration-files %}
580
562
581
-
{% ifversion code-scanning-config-input %}
582
-
583
563
## Specifying configuration details using the `config` input
584
564
585
565
If you'd prefer to specify additional configuration details in the workflow file, you can use the `config` input of the `init` command of the {% data variables.product.prodname_codeql %} action. The value of this input must be a YAML string that follows the configuration file format documented at "[Using a custom configuration file](#using-a-custom-configuration-file)" above.
@@ -619,7 +599,6 @@ In the following example, `vars.CODEQL_CONF` is a {% data variables.product.prod
619
599
```
620
600
621
601
{% endtip %}
622
-
{% endif %}
623
602
624
603
## Configuring {% data variables.product.prodname_code_scanning %} for compiled languages
Copy file name to clipboardExpand all lines: content/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts.md
+1-15Lines changed: 1 addition & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,27 +55,13 @@ If you configure {% data variables.product.prodname_code_scanning %} using {% da
55
55
56
56
When {% data variables.product.prodname_code_scanning %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_caps %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users.
57
57
58
-
### About {% ifversion remove-code-scanning-configurations %}alerts from multiple configurations{% else %}analysis origins{% endif %}
You can run multiple configurations of code analysis on a repository, using different tools and targeting different languages or areas of the code. Each configuration of {% data variables.product.prodname_code_scanning %} generates a unique set of alerts. For example, an alert generated using the default {% data variables.product.prodname_codeql %} analysis with {% data variables.product.prodname_actions %} comes from a different configuration than an alert generated externally and uploaded via the {% data variables.product.prodname_code_scanning %} API.
62
61
63
62
If you use multiple configurations to analyze a file, any problems detected by the same query are reported as alerts generated by multiple configurations. If an alert exists in more than one configuration, the number of configurations appears next to the branch name in the "Affected branches" section on the right-hand side of the alert page. To view the configurations for an alert, in the "Affected branches" section, click a branch. A "Configurations analyzing" modal appears with the names of each configuration generating the alert for that branch. Below each configuration, you can see when that configuration's alert was last updated.
64
63
65
64
An alert may display different statuses from different configurations. To update the alert statuses, re-run each out-of-date configuration. Alternatively, you can delete stale configurations from a branch to remove outdated alerts. For more information on deleting stale configurations and alerts, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository#removing-stale-configurations-and-alerts-from-a-branch)."
66
-
{% else %}
67
-
You can run multiple configurations of code analysis on a repository, using different tools and targeting different languages or areas of the code. Each configuration of {% data variables.product.prodname_code_scanning %} is the analysis origin for all the alerts it generates. For example, an alert generated using the default {% data variables.product.prodname_codeql %} analysis with {% data variables.product.prodname_actions %} will have a different analysis origin from an alert generated externally and uploaded via the {% data variables.product.prodname_code_scanning %} API.
68
-
69
-
If you use multiple configurations to analyze a file, any problems detected by the same query are reported as alerts with multiple analysis origins. If an alert has more than one analysis origin, a {% octicon "workflow" aria-label="The workflow icon" %} icon will appear next to any relevant branch in the **Affected branches** section on the right-hand side of the alert page. You can hover over the {% octicon "workflow" aria-label="The workflow icon" %} icon to see the names of each analysis origin and the status of the alert for that analysis origin. You can also view the history of when alerts appeared in each analysis origin in the timeline on the alert page. If an alert only has one analysis origin, no information about analysis origins is displayed on the alert page.
70
-
71
-

72
-
73
-
{% note %}
74
-
75
-
**Note:** Sometimes a {% data variables.product.prodname_code_scanning %} alert displays as fixed for one analysis origin but is still open for a second analysis origin. You can resolve this by re-running the second {% data variables.product.prodname_code_scanning %} configuration to update the alert status for that analysis origin.
76
-
77
-
{% endnote %}
78
-
{% endif %}
79
65
80
66
### About labels for alerts that are not found in application code
Copy file name to clipboardExpand all lines: content/code-security/code-scanning/managing-code-scanning-alerts/managing-code-scanning-alerts-for-your-repository.md
+4-15Lines changed: 4 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -166,11 +166,9 @@ Alerts may be fixed in one branch but not in another. You can use the "Branch" f
If you run {% data variables.product.prodname_code_scanning %} using multiple configurations, the same alert will sometimes be generated by more than one configuration. Unless you run all configurations regularly, you may see alerts that are fixed in one configuration but not in another. These stale configurations and alerts can be removed from a branch. For more information, see "[Removing stale configurations and alerts from a branch](#removing-stale-configurations-and-alerts-from-a-branch)."
171
-
{% else %}
172
-
If you run {% data variables.product.prodname_code_scanning %} using multiple configurations, then sometimes an alert will have multiple analysis origins. Unless you run all configurations regularly, you may see alerts that are fixed in one analysis origin but not in another. For more information, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-analysis-origins)."
173
-
{% endif %}
171
+
174
172
{% endnote %}
175
173
176
174
## Dismissing alerts
@@ -184,8 +182,8 @@ When you dismiss an alert:
184
182
* It's dismissed in all branches.
185
183
* The alert is removed from the number of current alerts for your project.
186
184
* The alert is moved to the "Closed" list in the summary of alerts, from where you can reopen it, if required.
187
-
* The reason why you closed the alert is recorded.{% ifversion comment-dismissed-code-scanning-alert %}
188
-
* Optionally, you can comment on a dismissal to record the context of an alert dismissal.{% endif %}
185
+
* The reason why you closed the alert is recorded.
186
+
* Optionally, you can comment on a dismissal to record the context of an alert dismissal.
189
187
* Next time {% data variables.product.prodname_code_scanning %} runs, the same code won't generate an alert.
190
188
191
189
To dismiss alerts:
@@ -194,13 +192,8 @@ To dismiss alerts:
194
192
{% data reusables.repositories.sidebar-security %}
195
193
{% data reusables.repositories.sidebar-code-scanning-alerts %}
196
194
1. If you want to dismiss an alert, it's important to explore the alert first, so that you can choose the correct dismissal reason. Click the alert you'd like to explore.
1. Review the alert, then click **Dismiss alert** and choose, or type, a reason for closing the alert.
199
196

200
-
{%- else %}
201
-
1. Review the alert, then click **Dismiss** and choose a reason for closing the alert.
202
-

203
-
{%- endif %}
204
197
{% data reusables.code-scanning.choose-alert-dismissal-reason %}
205
198
206
199
{% data reusables.code-scanning.false-positive-fix-codeql %}
@@ -213,8 +206,6 @@ If a project has multiple alerts that you want to dismiss for the same reason, y
213
206
214
207
If you dismiss an alert but later realize that you need to fix the alert, you can re-open it and fix the problem with the code. Display the list of closed alerts, find the alert, display it, and reopen it. You can then fix the alert in the same way as any other alert.
## Removing stale configurations and alerts from a branch
219
210
220
211
You may have multiple code scanning configurations on a single repository. When run, multiple configurations can generate the same alert. Additionally, if the configurations are run on different schedules, the alert statuses may become out-of-date for infrequent or stale configurations. For more information on alerts from multiple configurations, see "[AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alerts-from-multiple-configurations)."
@@ -242,8 +233,6 @@ You may have multiple code scanning configurations on a single repository. When
242
233
243
234
{% endnote %}
244
235
245
-
{% endif %}
246
-
247
236
## Auditing responses to {% data variables.product.prodname_code_scanning %} alerts
248
237
249
238
{% data reusables.code-scanning.audit-code-scanning-events %}
0 commit comments