github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-10-03 09:14:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for the tools option in the various workflow files

Browse Source
This commit is contained in:
Fotis Koutoulakis (@NlightNFotis)
2024-05-10 16:57:20 +01:00
parent 4995c49010
commit 6182f337aa
3 changed files with 27 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.github/actions/check-codescanning-config/action.yml vendored
View File

@@ -29,7 +29,15 @@ inputs:
tools: tools:
required: true required: true
description: | description: |
The url of codeql to use. The version of the CodeQL tools to use. This can be any of the following:
- A local path to a tarball containing the CodeQL tools, or
- A URL to a GitHub release assets containing the CodeQL tools, or
- A special value `linked` which is forcing the use of the CodeQL tools
that the action has been bundled with.
If not specified, the Action will check in several places until it finds
the CodeQL tools.
runs: runs:
using: composite using: composite

10
.github/actions/query-filter-test/action.yml vendored
View File

@@ -23,7 +23,15 @@ inputs:
tools: tools:
required: true required: true
description: | description: |
The url of codeql to use. The version of the CodeQL tools to use. This can be any of the following:
- A local path to a tarball containing the CodeQL tools, or
- A URL to a GitHub release assets containing the CodeQL tools, or
- A special value `linked` which is forcing the use of the CodeQL tools
that the action has been bundled with.
If not specified, the Action will check in several places until it finds
the CodeQL tools.
runs: runs:
using: composite using: composite

11
init/action.yml
View File

@@ -3,9 +3,16 @@ description: 'Set up CodeQL'
author: 'GitHub' author: 'GitHub'
inputs: inputs:
tools: tools:
description: URL of CodeQL tools description: >-
The version of the CodeQL tools to use. This can be any of the following:
- A local path to a tarball containing the CodeQL tools, or
- A URL to a GitHub release assets containing the CodeQL tools, or
- A special value `linked` which is forcing the use of the CodeQL tools
that the action has been bundled with.
If not specified, the Action will check in several places until it finds the CodeQL tools.
required: false required: false
# If not specified the Action will check in several places until it finds the CodeQL tools.
languages: languages:
description: >- description: >-
A comma-separated list of CodeQL languages to analyze. A comma-separated list of CodeQL languages to analyze.