Add documentation for the tools option in the various workflow files

This commit is contained in:
Fotis Koutoulakis (@NlightNFotis) 2024-05-10 16:57:20 +01:00
Родитель 4995c49010
Коммит 6182f337aa
3 изменённых файлов: 27 добавлений и 4 удалений

Просмотреть файл

@ -29,7 +29,15 @@ inputs:
tools:
required: true
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:
using: composite

10
.github/actions/query-filter-test/action.yml поставляемый
Просмотреть файл

@ -23,7 +23,15 @@ inputs:
tools:
required: true
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:
using: composite

Просмотреть файл

@ -3,9 +3,16 @@ description: 'Set up CodeQL'
author: 'GitHub'
inputs:
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
# 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.