-
Notifications
You must be signed in to change notification settings - Fork 309
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add documentation for the tools
option in the various workflow files
#2284
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Co-authored-by: Henry Mercer <henrymercer@github.com>
@@ -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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
@@ -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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same comment as above.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think keeping this line and removing the #
is useful. At some point, but not here, we should document exactly which places are checked.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
… input in the description.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Description
Documents the
tools:
input and its options for the various workflow files.Companion PR to #2281
Fixes #1327
Merge / deployment checklist