Add deprecation message to add-snippets input.

github · Aug 21, 2024 · 4067cda · 4067cda
1 parent c24926b
commit 4067cda
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/analyze/action.yml b/analyze/action.yml
@@ -34,6 +34,11 @@ inputs:
     description: Specify whether or not to add code snippets to the output sarif file.
     required: false
     default: "false"
+    deprecationMessage: >-
+      The input "add-snippets" is deprecated and will be removed on the first release in August 2025.
+      When this input is set to true it is expected to add code snippets with an alert to the SARIF file.
+      However, since Code Scanning ignores code snippets provided as part of a SARIF file this is currently
+      a no operation. No alternative is available.
   skip-queries:
     description: If this option is set, the CodeQL database will be built but no queries will be run on it. Thus, no results will be produced.
     required: false