From 6182f337aa1e35fa26446c0960580b7bf7fefeba Mon Sep 17 00:00:00 2001 From: "Fotis Koutoulakis (@NlightNFotis)" Date: Fri, 10 May 2024 16:57:20 +0100 Subject: [PATCH 1/3] Add documentation for the tools option in the various workflow files --- .github/actions/check-codescanning-config/action.yml | 10 +++++++++- .github/actions/query-filter-test/action.yml | 10 +++++++++- init/action.yml | 11 +++++++++-- 3 files changed, 27 insertions(+), 4 deletions(-) diff --git a/.github/actions/check-codescanning-config/action.yml b/.github/actions/check-codescanning-config/action.yml index 4f878bf5a..4576a451a 100644 --- a/.github/actions/check-codescanning-config/action.yml +++ b/.github/actions/check-codescanning-config/action.yml @@ -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 diff --git a/.github/actions/query-filter-test/action.yml b/.github/actions/query-filter-test/action.yml index 6a2036382..66d3d900a 100644 --- a/.github/actions/query-filter-test/action.yml +++ b/.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 diff --git a/init/action.yml b/init/action.yml index 1e254d8c3..587d10892 100644 --- a/init/action.yml +++ b/init/action.yml @@ -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. From eb4969f5e26f407fe1630b3bd96a09a9e74b4976 Mon Sep 17 00:00:00 2001 From: Fotis Koutoulakis Date: Fri, 10 May 2024 18:03:16 +0100 Subject: [PATCH 2/3] Clarify wording Co-authored-by: Henry Mercer --- init/action.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/init/action.yml b/init/action.yml index 587d10892..c57a8f875 100644 --- a/init/action.yml +++ b/init/action.yml @@ -4,14 +4,14 @@ author: 'GitHub' inputs: 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. + 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: - If not specified, the Action will check in several places until it finds the CodeQL tools. + - 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. required: false languages: description: >- From 4f59156fc829aa9d88309ec5a680cba2b4f127a2 Mon Sep 17 00:00:00 2001 From: "Fotis Koutoulakis (@NlightNFotis)" Date: Mon, 13 May 2024 10:46:04 +0100 Subject: [PATCH 3/3] Improve wording on internal workflows and add clarification for tools input in the description. --- .github/actions/check-codescanning-config/action.yml | 3 ++- .github/actions/query-filter-test/action.yml | 3 ++- init/action.yml | 3 +++ 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/actions/check-codescanning-config/action.yml b/.github/actions/check-codescanning-config/action.yml index 4576a451a..02306e060 100644 --- a/.github/actions/check-codescanning-config/action.yml +++ b/.github/actions/check-codescanning-config/action.yml @@ -29,7 +29,8 @@ inputs: tools: required: true description: | - 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. + 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 diff --git a/.github/actions/query-filter-test/action.yml b/.github/actions/query-filter-test/action.yml index 66d3d900a..9e354fbd4 100644 --- a/.github/actions/query-filter-test/action.yml +++ b/.github/actions/query-filter-test/action.yml @@ -23,7 +23,8 @@ inputs: tools: required: true description: | - 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. + 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 diff --git a/init/action.yml b/init/action.yml index c57a8f875..7124bb905 100644 --- a/init/action.yml +++ b/init/action.yml @@ -12,6 +12,9 @@ inputs: - 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 languages: description: >-