diff --git a/.github/actions/check-codescanning-config/action.yml b/.github/actions/check-codescanning-config/action.yml index 4f878bf5a..02306e060 100644 --- a/.github/actions/check-codescanning-config/action.yml +++ b/.github/actions/check-codescanning-config/action.yml @@ -29,7 +29,16 @@ inputs: tools: required: true description: | - The url of codeql to use. + The version of CodeQL passed to the `tools` input of the init action. + 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: using: composite diff --git a/.github/actions/query-filter-test/action.yml b/.github/actions/query-filter-test/action.yml index 6a2036382..9e354fbd4 100644 --- a/.github/actions/query-filter-test/action.yml +++ b/.github/actions/query-filter-test/action.yml @@ -23,7 +23,16 @@ inputs: tools: required: true description: | - The url of codeql to use. + The version of CodeQL passed to the `tools` input of the init action. + 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: using: composite diff --git a/init/action.yml b/init/action.yml index 1e254d8c3..7124bb905 100644 --- a/init/action.yml +++ b/init/action.yml @@ -3,9 +3,19 @@ description: 'Set up CodeQL' author: 'GitHub' inputs: tools: - description: URL of CodeQL tools + description: >- + By default, the Action will use the recommended version of the CodeQL + Bundle to analyze your project. You can override this choice using this + input. One of: + + - A local path to a CodeQL Bundle tarball, or + - The URL of a CodeQL Bundle tarball GitHub release asset, or + - A special value `linked` which uses the version 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 - # If not specified the Action will check in several places until it finds the CodeQL tools. languages: description: >- A comma-separated list of CodeQL languages to analyze.