text stringlengths 12 91.7k | metadata dict |
|---|---|
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack resolve-dependencies <options>... -- <dir>
Description
\[Plumbing] Compute the set of required dependencies for this QL pack. | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-resolve-dependencies.md",
"title": "pack resolve-dependencies"
} |
This command searches the configured registries for required
dependencies and returns the list of resolved dependencies.
Available since v2.6.0.
Options
Primary Options
<dir
The root directory of the package.
--format=<fmt
Select output format, either text (default) or json.
--mode=<mode
Specifies how to resolve d... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-resolve-dependencies.md",
"title": "pack resolve-dependencies"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql pack upgrade [--force] <options>... -- <dir>
Description
Update the dependencies for this pack to the latest available versions.
This command installs the latest compat... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-upgrade.md",
"title": "pack upgrade"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql query compile [--check-only] [--keep-going] [--threads=<num>] [--ram=<MB>] <options>... -- <file>...
Description
Compile or check QL code.
Compile one or more queries. ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-compile.md",
"title": "query compile"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql query decompile [--output=<file>] <options>... -- <file>
Description
\[Plumbing] Read an intermediate representation of a compiled query
from a .qlo file.
The code will... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-decompile.md",
"title": "query decompile"
} |
The default is dil if the query was compiled with
--include-dil-in-qlo and ra otherwise
Common options
-h, --help
Show this help text.
-J=<opt
\[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
-v, --verbose
Incrementally increase the numbe... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-decompile.md",
"title": "query decompile"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql query format [--output=<file>] [--in-place] [--backup=<ext>] <options>... -- <file>...
Description
Autoformat QL source code.
Options
Primary Options
<file...
One or... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-format.md",
"title": "query format"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql query run (--database=<database> | --dataset=<dataset>) [--output=<file.bqrs>] [--threads=<num>] [--ram=<MB>] <options>... -- <file.ql>
Description
Run a single query.
... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run.md",
"title": "query run"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve database <options>... -- <database>
Description
\[Deep plumbing] Report metadata about the database.
Options
Primary Options
<database
\[Mandatory] The datab... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-database.md",
"title": "resolve database"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve extensions-by-pack <options>... -- <pack>...
Description
\[Deep plumbing] Determine accessible data extensions for the given
paths to pack roots.
This plumbing ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions-by-pack.md",
"title": "resolve extensions-by-pack"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve extensions <options>... -- <query|dir|suite|pack>...
Description
\[Deep plumbing] Determine accessible data extensions.
This plumbing command resolves the set o... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extensions.md",
"title": "resolve extensions"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve extractor --language=<lang> <options>...
Description
\[Deep plumbing] Determine the extractor pack to use for a given
language.
Options
Primary Options
-l, -... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-extractor.md",
"title": "resolve extractor"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve files <options>... -- <dir>
Description
\[Deep plumbing] Expand a set of file inclusion/exclusion globs.
This plumbing command is responsible for expanding the ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-files.md",
"title": "resolve files"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve languages <options>...
Description
List installed CodeQL extractor packs.
When run with JSON output selected, this command can report multiple
locations for eac... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-languages.md",
"title": "resolve languages"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve library-path (--query=<qlfile> | --dir=<dir> | --root-pack=<pkgname>) <options>...
Description
\[Deep plumbing] Determine QL library path and dbscheme for a que... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-library-path.md",
"title": "resolve library-path"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve metadata <options>... -- <file>
Description
\[Deep plumbing] Resolve and return the key-value metadata pairs from a
query source file.
Options
Primary Options... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-metadata.md",
"title": "resolve metadata"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve ml-models <options>... -- <query|dir|suite|pack>...
Description
\[Deprecated] \[Deep plumbing] Determine accessible machine learning
models.
This plumbing comma... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ml-models.md",
"title": "resolve ml-models"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve packs <options>...
Description
Display a list of available CodeQL packs and their locations.
This command shows all of the locations searched for CodeQL packs, ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-packs.md",
"title": "resolve packs"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve qlpacks <options>...
Description
\[Deprecated] Create a list of installed QL packs and their locations.
This command is deprecated. Use the codeql resolve packs... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlpacks.md",
"title": "resolve qlpacks"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve qlref <options>... -- <qlref>
Description
\[Deep plumbing] Dereferences a .qlref file to return a .ql one.
Accepts a .qlref file and returns the .ql file that i... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-qlref.md",
"title": "resolve qlref"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve queries <options>... -- <query|dir|suite|pack>...
Description
\[Deep plumbing] Expand query directories and suite specifications.
This plumbing command is respo... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-queries.md",
"title": "resolve queries"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve ram [--ram=<MB>] <options>...
Description
\[Deep plumbing] Prepare RAM options.
This deep plumbing command prepares appropriate command-line options to
start a ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-ram.md",
"title": "resolve ram"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve tests <options>... -- <test|dir>...
Description
\[Deep plumbing] Find QL unit tests in given directories.
This plumbing command is responsible for expanding the... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-tests.md",
"title": "resolve tests"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql resolve upgrades --dbscheme=<file> <options>...
Description
\[Deep plumbing] Determine upgrades to run for a raw dataset.
Determine which upgrades need to be performed ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-upgrades.md",
"title": "resolve upgrades"
} |
Include any relevant downgrades if there are no upgrades
Common options
-h, --help
Show this help text.
-J=<opt
\[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
-v, --verbose
Incrementally increase the number of progress messages printed.... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/resolve-upgrades.md",
"title": "resolve upgrades"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql test accept <options>... -- <test|dir>...
Description
Accept results of failing unit tests.
This is a convenience command that renames the .actual files left by
codeql ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-accept.md",
"title": "test accept"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql test extract [--print-database] [--source-root=<dir>] <options>... -- <testDirectory>
Description
\[Plumbing] Build a dataset for a test directory.
Build a database for... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-extract.md",
"title": "test extract"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql test run [--threads=<num>] [--ram=<MB>] <options>... -- <test|dir>...
Description
Run unit tests for QL queries.
Options
Primary Options
<testdir...
Each argument is... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run.md",
"title": "test run"
} |
<!-- markdownlint-disable GHD053 --
<!-- markdownlint-disable GHD030 --
<!-- Content after this section is automatically generated --
Synopsis
codeql version <options>...
Description
Show the version of the CodeQL toolchain.
Options
Primary Options
--format=<fmt
Select output format. Choices include text (default)... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-cli-manual/version.md",
"title": "version"
} |
About this warning
Publicly visible controller repository can't be used to analyze private repositories. NUMBER private repositories were not analyzed.
If you run variant analysis on a custom list of repositories, you may receive this warning as a banner in , where NUMBER is the number of private repositories that have... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-for-vs-code/controller-repository-warning.md",
"title": "Problem with controller repository"
} |
This data will not be shared with any parties outside of . IP addresses and installation IDs will be retained for a maximum of 30 days. Anonymous data will be retained for a maximum of 180 days.
[!NOTE]
Telemetry collection in for follows the telemetry settings. When telemetry collection is disabled, no data will ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-for-vs-code/telemetry-in-codeql-for-visual-studio-code.md",
"title": "Telemetry in CodeQL for Visual Studio Code"
} |
includes many queries for analyzing workflows.
Built-in queries for analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/actions-built-in-queries.md",
"title": "GitHub Actions queries for CodeQL analysis"
} |
About built-in queries for CodeQL analysis
For each language, the following articles list which queries are included in the default and the security-extended suites. Where is available for a language, details of which queries are supported are also included.
For more information about CodeQL query suites, see AUTOTITL... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/built-in-queries.md",
"title": "About built-in CodeQL queries"
} |
includes many queries for analyzing C and C++ code.
Built-in queries for C and C++ analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/c-cpp-built-in-queries.md",
"title": "C and C++ queries for CodeQL analysis"
} |
includes many queries for analyzing C code.
Built-in queries for C analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/csharp-built-in-queries.md",
"title": "C# queries for CodeQL analysis"
} |
includes many queries for analyzing Go code.
Built-in queries for Go analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/go-built-in-queries.md",
"title": "Go queries for CodeQL analysis"
} |
includes many queries for analyzing Java and Kotlin code.
Built-in queries for Java and Kotlin analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/java-kotlin-built-in-queries.md",
"title": "Java and Kotlin queries for CodeQL analysis"
} |
includes many queries for analyzing JavaScript and TypeScript code.
Built-in queries for JavaScript and TypeScript analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/javascript-typescript-built-in-queries.md",
"title": "JavaScript and TypeScript queries for CodeQL analysis"
} |
includes many queries for analyzing Python code.
Built-in queries for Python analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/python-built-in-queries.md",
"title": "Python queries for CodeQL analysis"
} |
includes many queries for analyzing Ruby code.
Built-in queries for Ruby analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/ruby-built-in-queries.md",
"title": "Ruby queries for CodeQL analysis"
} |
includes many queries for analyzing Rust code.
Built-in queries for Rust analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/rust-built-in-queries.md",
"title": "Rust queries for CodeQL analysis"
} |
includes many queries for analyzing Swift code.
Built-in queries for Swift analysis | {
"source": "github-docs/code-security/reference/code-scanning/codeql/codeql-queries/swift-built-in-queries.md",
"title": "Swift queries for CodeQL analysis"
} |
You can configure on or on an external CI system. is fully compatible with -hosted runners on .
If you're using an external CI system, or self-hosted runners on for private repositories, you're responsible for configuring your own hardware. The optimal hardware configuration for running may vary based on the size ... | {
"source": "github-docs/code-security/reference/code-scanning/codeql/hardware-resources-for-codeql.md",
"title": "Recommended hardware resources for running CodeQL"
} |
can parse SARIF files produced by third-party tools to display alerts in repositories. For more information, see AUTOTITLE.
This article highlights key properties of SARIF files to help you upload SARIF files that meet 's requirements and can be converted into useful alerts.
If you're using with the or using the , t... | {
"source": "github-docs/code-security/reference/code-scanning/sarif-files/sarif-support.md",
"title": "SARIF support for code scanning"
} |
About this error
Upload with CodeQL results rejected due to "default setup"
This error is reported if a process attempts to upload a SARIF file containing results of analysis to a repository where default setup is enabled. This includes uploads using the REST API and the . SARIF uploads are blocked when default setu... | {
"source": "github-docs/code-security/reference/code-scanning/sarif-files/troubleshoot-sarif-uploads/default-setup-enabled.md",
"title": "Upload was rejected because CodeQL default setup is enabled for {% data variables.product.prodname_code_scanning %}"
} |
About this error
SARIF file is too large
SARIF results file is too large
SARIF upload is rejected (bigger than allowed size for zip archive) | {
"source": "github-docs/code-security/reference/code-scanning/sarif-files/troubleshoot-sarif-uploads/file-too-large.md",
"title": "SARIF results file is too large"
} |
SARIF ZIP upload is too large
A fatal error occurred: SARIF file is too large
413: Payload Too Large
One of these errors is reported if a process attempts to upload a SARIF file that is larger than the maximum size of 10 MB. does not accept files above this size. There are several different ways to reduce the number o... | {
"source": "github-docs/code-security/reference/code-scanning/sarif-files/troubleshoot-sarif-uploads/file-too-large.md",
"title": "SARIF results file is too large"
} |
About this error
{% data variables.product.prodname_GHAS_or_code_security %} not enabled
{% data variables.product.prodname_GHAS_or_code_security %} blocked by a policy
403: {% data variables.product.prodname_GHAS_or_code_security %} is not enabled
This error is reported if a process attempts to upload a SARIF file to ... | {
"source": "github-docs/code-security/reference/code-scanning/sarif-files/troubleshoot-sarif-uploads/ghas-required.md",
"title": "Upload fails because {% data variables.product.prodname_GH_code_security %} is disabled"
} |
About this error
A GitHub token is required to upload SARIF results but none was specified
This error is reported if the upload process does not reference an authentication method, or if that method has the wrong permission. The permissions required to upload SARIF file to a repository are the same no matter what proce... | {
"source": "github-docs/code-security/reference/code-scanning/sarif-files/troubleshoot-sarif-uploads/missing-token.md",
"title": "GitHub token is required to upload SARIF results"
} |
About limits on SARIF results
# SARIF results exceed soft limits
Locations for an alert exceeded limits
Analysis SARIF file exceeded alert limits
Rule tags in SARIF file exceed limits
Alert in SARIF upload exceeded thread flow location limits
Repository is at risk of exceeding the alert limit.
# SARIF result... | {
"source": "github-docs/code-security/reference/code-scanning/sarif-files/troubleshoot-sarif-uploads/results-exceed-limit.md",
"title": "SARIF results exceed one or more limits"
} |
About this error
Invalid SARIF
SARIF file invalid
SARIF ZIP upload is invalid
400: Bad Request if the sarif field is invalid
One of these errors is reported if cannot parse the SARIF file.
You are unlikely to see this error when using analysis.
Confirming the cause of the error
You can investigate the underlying cau... | {
"source": "github-docs/code-security/reference/code-scanning/sarif-files/troubleshoot-sarif-uploads/sarif-invalid.md",
"title": "SARIF file is invalid"
} |
About this error
{% data variables.product.prodname_GHAS_or_code_security %} must be enabled for this repository to use code scanning
403: {% data variables.product.prodname_GHAS_or_code_security %} is not enabled
This error is reported if you try to run in a repository where is not enabled or where use of this featu... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/advanced-security-must-be-enabled.md",
"title": "Error: \"{% data variables.product.prodname_GHAS_or_code_security %} must be enabled for this repository to use code scanning"
} |
There are several approaches you can try to reduce the build time in a analysis.
Increase the memory or cores
If you're using -hosted runners for your analysis, consider upgrading to . These are -hosted runners with more RAM, CPU, and disk space than standard runners. For more information about and , see AUTOTITLE ... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/analysis-takes-too-long.md",
"title": "Code scanning analysis takes too long"
} |
If an automatic build of code for a compiled language within your project fails, you can try changing to the manual build mode or removing the autobuild step from your workflow and adding specific build steps. If you're not already using advanced setup, you'll need to enable it first to create a workflow you can edit.... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/automatic-build-failed.md",
"title": "Automatic build failed for a compiled language"
} |
About these errors
The tracer injects some flags into the C compiler invocation to ensure every component is built and included in the database, which may cause your C code to build differently to what you expect during analysis. See AUTOTITLE.
/p:EmitCompilerGeneratedFiles=true is one of the injected properties, an... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/c-sharp-compiler-unexpectedly-failing.md",
"title": "C# compiler unexpectedly failing"
} |
When you enable default setup, a workflow is triggered with the automatically generated configuration. This run is used to test whether default setup works for all -supported languages in the repository.
You can check on the progress of the test run for default setup on the Actions tab. If the run is taking too long, t... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/default-setup-timeout.md",
"title": "Enabling default setup takes too long"
} |
The team constantly works on critical extraction errors to make sure that all source files can be scanned. However, the extractors do occasionally generate errors during database creation. provides information about extraction errors and warnings generated during database creation in a log file.
The extraction diagn... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/extraction-errors-in-the-database.md",
"title": "Extraction errors in the database"
} |
About analysis of compiled languages
When compiled languages are analyzed using the autobuild or manual build mode, only scans files that are built during the analysis. Therefore the number of lines of code scanned will be lower than expected if some of the source code isn't compiled correctly. This can happen for sev... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/fewer-lines-scanned-than-expected.md",
"title": "CodeQL scanned fewer lines than expected"
} |
About this warning
Warning: Detected X Kotlin files in your project that could not be processed without a build. To process these files...
This warning is reported when Kotlin files are detected in a repository that ran for Java using the build mode of none (default setup), or if you run the using --build-mode none ... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/kotlin-detected-in-no-build.md",
"title": "Warning: Detected X Kotlin files in your project that could not be processed without a build"
} |
If your logs are not detailed enough to troubleshoot a problem, there are several steps you can take to obtain extra information and make logs more useful.
Enabling step debug logging
Step debug logging increases the verbosity of a job’s logs during and after execution.
To enable step debug logging:
1. In the reposito... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/logs-not-detailed-enough.md",
"title": "Logs are not detailed enough"
} |
<!-- CodeQL CLI depends on a short URL generated from this article's URL. If this article's URL ever changes, make sure to update the short URL https://gh.io/troubleshooting-code-scanning/no-source-code-seen-during-build. https://thehub.github.com/it/how-to/url-shortening --
If your workflow fails with Error: "No sourc... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/no-source-code-seen-during-build.md",
"title": "Error: \"No source code was seen during the build"
} |
About this error
Is not a .ql file, .qls file, a directory, or a query pack specification.
You will see this error if is unable to find the named query, query suite, or query pack at the location requested in the workflow.
Confirming the cause of the error
There are two common reasons for this error:
There is a typo... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/not-recognized.md",
"title": "Error: \"is not a .ql file, .qls file, a directory, or a query pack specification"
} |
<!-- CodeQL CLI depends on a short URL generated from this article's URL. If this article's URL ever changes, make sure to update the short URL https://gh.io/troubleshooting-code-scanning/out-of-disk-or-memory. https://thehub.github.com/it/how-to/url-shortening --
About these errors
You may see these errors when runni... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/out-of-disk-or-memory.md",
"title": "Out of disk\" and \"Out of memory\" errors"
} |
If you are on a or plan, you can only use on repositories that are publicly available. To enable for private or internal repositories, you must upgrade to or with and enable for the repository. For more information, see AUTOTITLE and AUTOTITLE.
Confirm whether is enabled
1. On the settings page, scroll down t... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/private-repository-enablement.md",
"title": "Cannot enable CodeQL in a private repository"
} |
[!NOTE]
This troubleshooting article is only relevant if you're seeing this error with . If you see this error with other products and have difficulty troubleshooting it, you can contact . For more information, see AUTOTITLE.
About this error
403: Resource not accessible by integration
is considered untrusted when i... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/resource-not-accessible.md",
"title": "Error: 403 \"Resource not accessible by integration"
} |
If your results are different than you expected, you may have both default and advanced setup configured for your repository. When you enable default setup, this disables the existing workflow file and blocks any API analysis from uploading results.
To check if default setup is enabled, navigate to the main page of ... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/results-different-than-expected.md",
"title": "Results are different than expected"
} |
About this error
Server error
If the run of a workflow for fails due to a server error, this may be due to a transient communication issue.
Confirming the cause of the error
You can check the current "Actions" service status on the Status Dashboard.
Fixing the problem
Try running the workflow again. If the problem p... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/server-error.md",
"title": "Error: \"Server error"
} |
If you're using advanced setup and your workflow doesn't explicitly specify the languages to analyze, implicitly detects the supported languages in your code base. In this configuration, out of the compiled languages , only analyzes the language with the most source files. Edit the workflow and add a matrix specifyin... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/some-languages-not-analyzed.md",
"title": "Some languages were not analyzed with CodeQL advanced setup"
} |
Default setup overrides existing setups by disabling any existing workflows, and blocking any analysis API uploads. This behavior stops you using minutes to run workflows for advanced setup when only the results from default setup will be used. For more information about switching between advanced and default setu... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/two-codeql-workflows.md",
"title": "Two CodeQL workflows"
} |
The shows you how well tools are working for a repository, when files in the repository were first scanned and most recently scanned, and when scans are scheduled. For integrated tools like , you can also see more detailed information, including a percentage of files scanned and specific error messages. For more info... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/unclear-what-triggered-a-workflow.md",
"title": "Unclear what triggered a workflow run"
} |
About this warning
Warning: 1 issue was detected with this workflow: git checkout HEAD^2 is no longer
necessary. Please remove this step as Code Scanning recommends analyzing the merge
commit for best results.
If you're using an old workflow you may receive this warning from the "Initialize " action.
Confirm the caus... | {
"source": "github-docs/code-security/reference/code-scanning/troubleshoot-analysis-errors/unnecessary-step-found.md",
"title": "Warning: \"1 issue was detected with this workflow: git checkout HEAD^2 is no longer necessary"
} |
<!--The CodeQL CLI man pages include a link to a section of the article. If you rename this article,
make sure that you also update the MS short link: https://aka.ms/code-scanning-docs/config-file.--
Prerequisites
You must use advanced setup for and be able to edit the workflow file where your configuration is define... | {
"source": "github-docs/code-security/reference/code-scanning/workflow-configuration-options.md",
"title": "Workflow configuration options for code scanning"
} |
Permissions overview
Action Write permissions Admin permissions
------ ----------------- -----------------
See a draft security advisory
Add collaborators to the security advisory (see AUTOTITLE)
Edit and delete any comments in the security advisory
Create a temporary private fork in the secur... | {
"source": "github-docs/code-security/reference/permissions/repository-security-advisory.md",
"title": "Repository security advisories"
} |
The actions you can take in the security overview depend on your permissions for the repositories in your organization or enterprise.
Organization-level overview
If you are an owner or security manager for an organization, you can see data for all the repositories in the organization in all views.
If you are an organi... | {
"source": "github-docs/code-security/reference/permissions/security-overview.md",
"title": "Security overview permissions"
} |
Regular expression library for custom patterns
custom patterns are defined using the Hyperscan library and only support Hyperscan regex constructs, which are a subset of PCRE syntax. Hyperscan option modifiers are not supported. For more information on Hyperscan pattern constructs, see Pattern support in the Hyperscan... | {
"source": "github-docs/code-security/reference/secret-security/custom-patterns.md",
"title": "Custom patterns reference"
} |
The report CSV file includes the following information:
CSV column Name Description
---------- ---------------------- ---------------------------------------------------------
A Organization Name The name of the organization the sec... | {
"source": "github-docs/code-security/reference/secret-security/risk-report-csv-contents.md",
"title": "Contents of the secret risk assessment report CSV"
} |
When configuring push protection, you can view performance data for each secret pattern to make informed enablement decisions. Use metrics like alert volume and false positive rates to balance security with developer experience. See AUTOTITLE or AUTOTITLE. | {
"source": "github-docs/code-security/reference/secret-security/secret-pattern-data.md",
"title": "Secret scanning pattern configuration data"
} |
Public monitoring scope
When public monitoring is enabled for your enterprise, extends detection beyond repositories your enterprise owns. Public monitoring scans public repositories, including non-code content like pull request comments, across for secrets associated with your enterprise members or users with an ema... | {
"source": "github-docs/code-security/reference/secret-security/secret-scanning-scope.md",
"title": "Secret scanning detection scope"
} |
How stores secrets
uses Libsodium sealed boxes to encrypt secrets. A secret is encrypted before reaching and remains encrypted until it's used by , , or .
secrets
secrets are used to store credentials and sensitive information for use within .
secrets are referenced in a repository's dependabot.yml file.
Usage
... | {
"source": "github-docs/code-security/reference/secret-security/secret-types.md",
"title": "Understanding GitHub secret types"
} |
About patterns
For in-depth information about each alert type, see AUTOTITLE.
If you use the REST API for , you can use the Secret type to report on secrets from specific issuers. For more information, see AUTOTITLE.
Pattern categories
Category Description Detection approach Example
-----------------------------... | {
"source": "github-docs/code-security/reference/secret-security/supported-secret-scanning-patterns.md",
"title": "Supported secret scanning patterns"
} |
can be enforced, meaning repository owners cannot change the enablement status of features that are enabled or disabled by the configuration.
Situations that break enforcement
Some situations can break the enforcement of . For example, the enablement of will not apply to a repository if:
is initially enabled on the... | {
"source": "github-docs/code-security/reference/security-at-scale/configuration-enforcement.md",
"title": "Security configuration enforcement"
} |
A repository's configuration status tells you the current state of its relationship with the applied . That relationship can change over time—for example, when a repository admin overrides a setting, an admin enables enforcement, or an attachment fails. For more about how configurations and repositories interact, see A... | {
"source": "github-docs/code-security/reference/security-at-scale/configuration-statuses.md",
"title": "Security configuration statuses"
} |
This article lists all available filters (qualifiers) for security overview. The available filters vary depending on the specific view and whether you are viewing data at the enterprise or organization level.
For information about how to apply filters, see AUTOTITLE.
[!NOTE]
Filter logic for security overview
You can... | {
"source": "github-docs/code-security/reference/security-at-scale/overview-dashboard-filters.md",
"title": "Available filters for security overview"
} |
QualifierDescription
----------------
code-scanning-alertsDisplay data for repositories that have exactly (=), more than () or fewer than (<) a specific number of alerts. For example: code-scanning-alerts:100 for repositories with more than 100 alerts.
dependabot-alertsDisplay data for repositories that have a specifi... | {
"source": "github-docs/code-security/reference/security-at-scale/overview-dashboard-filters.md",
"title": "Available filters for security overview"
} |
QualifierDescription
----------------
codeql.rule Display data only for identified by a specific rule for .
dependabot.ecosystem Display data only for for a specific ecosystem, for example: npm.
dependabot.package Display data only for for a specific package, for example: tensorflow.
dependabot.scope Display data on... | {
"source": "github-docs/code-security/reference/security-at-scale/overview-dashboard-filters.md",
"title": "Available filters for security overview"
} |
Dashboard metrics
In security overview, the overview dashboard displays security alert metrics for your organization or enterprise. You can use the dashboard to monitor the health of your application security program, collaborate with engineering teams, and gather data for benchmarking purposes.
The dashboard displays ... | {
"source": "github-docs/code-security/reference/security-at-scale/overview-dashboard-metrics.md",
"title": "Security overview dashboard metrics"
} |
About the problem
You cannot successfully apply a with default setup set to "Enabled" to a target repository that has an active configuration of advanced setup for . Advanced setups are tailored to the specific security needs of the repositories they are applied to, so they are not intended to be overridden at scale.... | {
"source": "github-docs/code-security/reference/security-at-scale/troubleshoot-security-configurations/a-repository-is-using-advanced-setup-for-code-scanning.md",
"title": "A repository is using advanced setup for code scanning"
} |
Finding and remediating attachment failures
When you apply a configuration to a group of repositories, some repositories may fail to attach, typically because of a conflict between existing repository settings and the configuration you applied. When this happens, only some settings are applied to the affected repositor... | {
"source": "github-docs/code-security/reference/security-at-scale/troubleshoot-security-configurations/configuration-issue-diagnosis.md",
"title": "Diagnosing security configuration issues"
} |
About the problem
Security configurations only include features that have been installed by a site administrator on your instance.
If a site administrator changes the installation settings for a feature on your instance, your configuration may be impacted.
After you have created and applied a security configuration t... | {
"source": "github-docs/code-security/reference/security-at-scale/troubleshoot-security-configurations/feature-disappears.md",
"title": "A feature has disappeared from a security configuration"
} |
If you are on a volume / subscription-based billing model for (GHAS), you must have an available GHAS license for any additional unique active committers to enable GHAS features on a private or internal repository. To learn about GHAS licensing, as well as unique and active committers, see AUTOTITLE.
If you try to app... | {
"source": "github-docs/code-security/reference/security-at-scale/troubleshoot-security-configurations/not-enough-ghas-licenses.md",
"title": "Not enough GitHub Advanced Security licenses"
} |
About the problem
When you apply a and is defined as "Enabled with advanced setup allowed", each repository is checked to see if there is an existing, active, advanced setup.
No change to if an active advanced setup configuration is detected.
Default setup is enabled for repositories where advanced setup is inacti... | {
"source": "github-docs/code-security/reference/security-at-scale/troubleshoot-security-configurations/unexpected-default-setup.md",
"title": "Default setup for code scanning overrides advanced setup"
} |
This reference article shows you which tools to use and which surfaces to check when you're responding to a security incident. Use this article to guide your investigation across major threat categories.
For full guidance on how to respond to a security incident, including containment strategies, see AUTOTITLE.
[!IM... | {
"source": "github-docs/code-security/reference/security-incident-response/investigation-areas.md",
"title": "Common security incident investigation areas"
} |
Use this reference to decide which tools to use during a security investigation, what questions each tool can answer, and what factors may affect the data you can see.
[!NOTE]
The availability of each tool (and the data it provides) varies by plan, your role and permissions, feature enablement, and pre-incident con... | {
"source": "github-docs/code-security/reference/security-incident-response/investigation-tools.md",
"title": "Investigation tools for security incidents"
} |
Configure network access for self-hosted runners
If your self-hosted runners operate behind a firewall with restricted outbound internet access, you must add certain URLs to the allowlist for automatic dependency submission. The required URLs depend on the ecosystems your repositories use.
Required URLs for all ecosys... | {
"source": "github-docs/code-security/reference/supply-chain-security/automatic-dependency-submission.md",
"title": "Automatic dependency submission"
} |
Dismiss low impact issues for development-scoped dependencies
Along with the ecosystem:npm and scope:development alert metadata, we use the following -curated Common Weakness Enumerations (CWEs) to filter out low impact alerts for the Dismiss low impact issues for development-scoped dependencies rule. We regularly impr... | {
"source": "github-docs/code-security/reference/supply-chain-security/criteria-for-preset-rules.md",
"title": "CWEs used by GitHub's preset Dependabot rules"
} |
Restrictions when triggers events
For workflows initiated by (github.actor == 'dependabot[bot]') using the pullrequest, pullrequestreview, pullrequestreviewcomment, push, create, deployment, and deploymentstatus events, these restrictions apply:
GITHUBTOKEN has read-only permissions by default.
Secrets are populate... | {
"source": "github-docs/code-security/reference/supply-chain-security/dependabot-on-actions.md",
"title": "Dependabot on GitHub Actions"
} |
This article provides reference information for the configuration options available in the dependabot.yml file. Use these options to customize how monitors package ecosystems, schedules updates, and creates pull requests. For an overview of the dependabot.yml file and how it works, see AUTOTITLE.
All options marked wi... | {
"source": "github-docs/code-security/reference/supply-chain-security/dependabot-options-reference.md",
"title": "Dependabot options reference"
} |
Parameters Purpose
--------------------
IDENTIFIER Define an identifier for the group to use in branch names and pull request titles. This must start and end with a letter, and can contain letters, pipes \, underscores , or hyphens -.
applies-to Specify which type of update the group applies to. When undefined, ... | {
"source": "github-docs/code-security/reference/supply-chain-security/dependabot-options-reference.md",
"title": "Dependabot options reference"
} |
Package manager YAML value Supported versions
---------------------------------:------------------:
Bazel bazel v7, v8, v9
Bun bun =v1.1.39
Bundler bundler v2
Cargo cargo v1
Composer composer v2 ... | {
"source": "github-docs/code-security/reference/supply-chain-security/dependabot-options-reference.md",
"title": "Dependabot options reference"
} |
responds to simple commands in comments. Each pull request contains details of the commands you can use to process the pull request (for example, to rebase the pull request) under the " commands and options" section. The aim is to make it as easy as possible for you to triage these automatically generated pull requests... | {
"source": "github-docs/code-security/reference/supply-chain-security/dependabot-pull-request-comment-commands.md",
"title": "Dependabot pull request comment commands"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.