Skip to content

Deprecate add-snippets input. #2436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rvermeulen merged 5 commits into from
Aug 21, 2024
Merged

Deprecate add-snippets input. #2436

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4067cda
Add deprecation message to `add-snippets` input.
Aug 21, 2024
ec21b8f
Update changelog with deprecation.
Aug 21, 2024
d7c48ef
Add link to PR deprecating `add-snippets` to CHANGELOG.md
rvermeulen Aug 21, 2024
7388c47
Merge branch 'main' into rvermeulen/deprecate-add-snippets
rvermeulen Aug 21, 2024
72bc3f7
Address incorrect changelog location
Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment thread
rvermeulen marked this conversation as resolved.
Outdated

## 3.25.15 - 26 Jul 2024

Expand Down
5 changes: 5 additions & 0 deletions analyze/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down