Add documentation for the tools option in the various workflow files - #2284
NlightNFotis merged 3 commits into
Conversation
Sorry, something went wrong.
henrymercer
left a comment
There was a problem hiding this comment.
Thanks! I made a suggestion to make it clearer the recommended case of not passing this input to let the CodeQL Action choose which tools to use.
Sorry, something went wrong.
Co-authored-by: Henry Mercer <henrymercer@github.com>
| required: true | ||
| description: | | ||
| The url of codeql to use. | ||
| The version of the CodeQL tools to use. This can be any of the following: |
There was a problem hiding this comment.
This is an action used internally for testing only. Maybe better to change this to:
| The version of the CodeQL tools to use. This can be any of the following: | |
| The version of CodeQL passed to the `tools` input of the init action. |
Sorry, something went wrong.
| required: true | ||
| description: | | ||
| The url of codeql to use. | ||
| The version of the CodeQL tools to use. This can be any of the following: |
There was a problem hiding this comment.
Same comment as above.
Sorry, something went wrong.
| - A special value `linked` which uses the version of the CodeQL tools | ||
| that the Action has been bundled with. | ||
| required: false | ||
| # If not specified the Action will check in several places until it finds the CodeQL tools. |
There was a problem hiding this comment.
I think keeping this line and removing the # is useful. At some point, but not here, we should document exactly which places are checked.
Sorry, something went wrong.
There was a problem hiding this comment.
The "check in several places" comment feels more about implementation under the hood than what the input actually means, and in fact applies even if you do specify an input. For instance, if you specify a URL we will try to extract the CodeQL version from the URL and use the toolcache if we can find a matching version. Overall, I'd prefer to remove this in favour of saying we'll use the recommended version if you don't specify an input, but I don't feel that strongly about it.
Sorry, something went wrong.
… input in the description.
| - A special value `linked` which uses the version of the CodeQL tools | ||
| that the Action has been bundled with. | ||
| required: false | ||
| # If not specified the Action will check in several places until it finds the CodeQL tools. |
There was a problem hiding this comment.
The "check in several places" comment feels more about implementation under the hood than what the input actually means, and in fact applies even if you do specify an input. For instance, if you specify a URL we will try to extract the CodeQL version from the URL and use the toolcache if we can find a matching version. Overall, I'd prefer to remove this in favour of saying we'll use the recommended version if you don't specify an input, but I don't feel that strongly about it.
Sorry, something went wrong.
Description
Documents the tools: input and its options for the various workflow files.
Companion PR to #2281
Fixes #1327
Merge / deployment checklist