Improve wording on internal workflows and add clarification for tools…

… input in the description.
github · May 13, 2024 · 4f59156 · 4f59156
1 parent eb4969f
commit 4f59156
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git 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
@@ -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
@@ -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: >-