From 4067cdab784c667cf1b7fa95169f3a0e0a381d63 Mon Sep 17 00:00:00 2001 From: Remco Vermeulen Date: Tue, 20 Aug 2024 18:02:40 -0700 Subject: [PATCH 1/4] Add deprecation message to `add-snippets` input. --- analyze/action.yml | 5 +++++ 1 file changed, 5 insertions(+) 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 From ec21b8f8a46388ea7527dbba9f40d839d52aabaf Mon Sep 17 00:00:00 2001 From: Remco Vermeulen Date: Tue, 20 Aug 2024 18:06:38 -0700 Subject: [PATCH 2/4] Update changelog with deprecation. --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 34dd9259f6..5613351bcb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,7 @@ Note that the only difference between `v2` and `v3` of the CodeQL Action is the - _Deprecation:_ Swift analysis on Ubuntu runner images is no longer supported. Please migrate to a macOS runner if this affects you. [#2403](https://github.com/github/codeql-action/pull/2403) - Bump the minimum CodeQL bundle version to 2.13.5. [#2408](https://github.com/github/codeql-action/pull/2408) +- _Deprecation:_ The `add-snippets` input on the `analyze` Action is deprecated and will be removed in the first release in August 2025. ## 3.25.15 - 26 Jul 2024 From d7c48ef5a8182e33f305da9abd0f642eb687244d Mon Sep 17 00:00:00 2001 From: Remco Vermeulen Date: Wed, 21 Aug 2024 08:29:24 -0700 Subject: [PATCH 3/4] Add link to PR deprecating `add-snippets` to CHANGELOG.md Co-authored-by: Andrew Eisenberg --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5613351bcb..d2abe82800 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,7 +8,7 @@ Note that the only difference between `v2` and `v3` of the CodeQL Action is the - _Deprecation:_ Swift analysis on Ubuntu runner images is no longer supported. Please migrate to a macOS runner if this affects you. [#2403](https://github.com/github/codeql-action/pull/2403) - Bump the minimum CodeQL bundle version to 2.13.5. [#2408](https://github.com/github/codeql-action/pull/2408) -- _Deprecation:_ The `add-snippets` input on the `analyze` Action is deprecated and will be removed in the first release in August 2025. +- _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) ## 3.25.15 - 26 Jul 2024 From 72bc3f7f619fdbada5d8d589b47c52c32f9ad097 Mon Sep 17 00:00:00 2001 From: Remco Vermeulen Date: Wed, 21 Aug 2024 09:43:59 -0700 Subject: [PATCH 4/4] Address incorrect changelog location --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b6b56a840..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 @@ -24,7 +25,6 @@ No user facing changes. - _Deprecation:_ Swift analysis on Ubuntu runner images is no longer supported. Please migrate to a macOS runner if this affects you. [#2403](https://github.com/github/codeql-action/pull/2403) - Bump the minimum CodeQL bundle version to 2.13.5. [#2408](https://github.com/github/codeql-action/pull/2408) -- _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) ## 3.25.15 - 26 Jul 2024