| title | Repository properties for {% data variables.product.prodname_code_scanning %} | ||
|---|---|---|---|
| shortTitle | Repository properties | ||
| intro | You can use repository properties to adjust {% data variables.product.prodname_code_scanning %} to suit your needs. | ||
| versions |
|
||
| contentType | concepts | ||
| category |
|
For the repository properties described here to have an effect, you need to have set up {% data variables.product.prodname_code_scanning %}. See AUTOTITLE.
Repository properties which affect {% data variables.product.prodname_code_scanning %} must be created manually for your organization. You can then set values for them that apply to your entire organization or allow them to be configured differently for each repository. See AUTOTITLE.
Some {% data variables.product.prodname_code_scanning %} functionality can be configured using repository properties. Organizations can use repository properties to both enforce configurations across all repositories and for individual repositories. If {% data variables.product.prodname_code_scanning %} is customized using repository properties, the customization applies to all setup types.
The following is an overview of repository properties you can set up which affect {% data variables.product.prodname_code_scanning %} analyses when configured:
| Name | Type |
|---|---|
github-codeql-extra-queries |
Text |
github-codeql-disable-overlay |
True/false |
github-codeql-file-coverage-on-prs |
True/false |
Note
The repository properties which are supported depend on the version of the github/codeql-action that is used by your {% data variables.product.prodname_code_scanning %} analyses. For {% data variables.product.prodname_code_scanning %} advanced setup, check that your workflow is referencing the latest major version. {% data variables.product.prodname_code_scanning_caps %} default setup automatically uses the latest version.{% ifversion ghes %} If the server on which you are running {% data variables.product.prodname_ghe_server %} is not connected to the internet, you may need to use the {% data variables.product.prodname_codeql %} action sync tool. See AUTOTITLE.{% endif %}
The github-codeql-extra-queries property allows you to configure additional queries that should be run. This is useful to add queries to all relevant analyses in your organization without needing to modify individual workflows or switch to an advanced setup. This accepts the same values as the queries input of the github/codeql-action. See AUTOTITLE.
You can disable improved incremental analysis by setting the github-codeql-disable-overlay property to true. This may be useful if improved incremental analysis is failing because of increased hardware requirements.
File coverage information is not calculated for analyses of pull requests. If you want to enable file coverage information for pull requests, you can set the github-codeql-file-coverage-on-prs property to true.