diff --git a/CHANGELOG.md b/CHANGELOG.md index c5994267a6..566c981a46 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ Note that the only difference between `v2` and `v3` of the CodeQL Action is the ## [UNRELEASED] +- _Deprecation:_ The `add-snippets` input on the `analyze` Action is deprecated and will be removed in the first release in August 2025. [#2436](https://github.com/github/codeql-action/pull/2436) - Fix an issue where the disk usage system call used for telemetry would fail on MacOS ARM machines with System Integrity Protection disabled, and then surface a warning. The system call is now disabled for these machines. [#2434](https://github.com/github/codeql-action/pull/2434) ## 3.26.3 - 19 Aug 2024 diff --git a/analyze/action.yml b/analyze/action.yml index 2742bdf34c..aade3426a1 100644 --- 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