From 6182f337aa1e35fa26446c0960580b7bf7fefeba Mon Sep 17 00:00:00 2001
From: "Fotis Koutoulakis (@NlightNFotis)" <nlightnfotis@github.com>
Date: Fri, 10 May 2024 16:57:20 +0100
Subject: [PATCH] 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.