Skip to content

[Automated] Update snyk CLI Options - #4622

Open
thomhurst wants to merge 1 commit into
mainfrom
automated/update-cli-options-snyk
Open

[Automated] Update snyk CLI Options#4622
thomhurst wants to merge 1 commit into
mainfrom
automated/update-cli-options-snyk

Conversation

@thomhurst

@thomhurst thomhurst commented Sep 3, 2026

Copy link
Copy Markdown
Owner

Summary

This PR contains automatically generated updates to snyk CLI options classes.

The generator scraped the latest CLI help output from the installed tool.

Changes

  • Updated options classes to reflect latest CLI documentation
  • Added new commands if any were detected
  • Updated option types and descriptions

Assembly-wide public API impact

Affected API families: Snyk.

  • Added APIs: 17
  • Removed or changed APIs: 17
  • Members with matching names but changed signatures: 0

Breaking changes are present. Consumers may need to update method arguments, option property types or nullability, enum members, and references to removed APIs.

Representative removed or changed members:

  • ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold.High = 2 -> ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold
  • ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold.Low = 0 -> ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold
  • ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold.Medium = 1 -> ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold
  • ModularPipelines.Snyk.Enums.SnykFailOn.Patchable = 2 -> ModularPipelines.Snyk.Enums.SnykFailOn
  • ModularPipelines.Snyk.Enums.SnykFailOn.Upgradable = 1 -> ModularPipelines.Snyk.Enums.SnykFailOn

Representative added members:

  • ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold.High = 0 -> ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold
  • ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold.Low = 1 -> ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold
  • ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold.Medium = 2 -> ModularPipelines.Snyk.Enums.SnykCodeTestSeverityThreshold
  • ModularPipelines.Snyk.Enums.SnykFailOn.Patchable = 1 -> ModularPipelines.Snyk.Enums.SnykFailOn
  • ModularPipelines.Snyk.Enums.SnykFailOn.Upgradable = 2 -> ModularPipelines.Snyk.Enums.SnykFailOn

Command coverage

Command coverage report:

  • snyk (1.1306.1): 18 commands, tree 32de8a747296e31736bf613027b19e2b477465ca0d4198f0a4631966ff7f20ac
    • Baseline comparison: 18 commands at 1.1306.1 -> 18 commands at 1.1306.1

Verification

  • Solution builds successfully

🤖 Generated with ModularPipelines.OptionsGenerator

Summary by CodeRabbit

  • Breaking Changes
    • Updated the Snyk integration’s configuration option values for severity thresholds, failure conditions, file path groups, reachability filters, and vulnerable path display settings.
    • Several previously available named options are no longer included in the shipped public API.
    • Applications relying on these options or their numeric representations may require updates to remain compatible.

@thomhurst thomhurst added automated dependencies Pull requests that update a dependency file labels Sep 3, 2026
@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 294dac0e-34e8-4d7c-aec4-b307ca0776fe

📥 Commits

Reviewing files that changed from the base of the PR and between 49f5b9b and 93c5e65.

⛔ Files ignored due to path filters (7)
  • src/ModularPipelines.Snyk/Enums/SnykCodeTestSeverityThreshold.Generated.cs is excluded by !**/*.generated.*
  • src/ModularPipelines.Snyk/Enums/SnykFailOn.Generated.cs is excluded by !**/*.generated.*
  • src/ModularPipelines.Snyk/Enums/SnykFilePathGroup.Generated.cs is excluded by !**/*.generated.*
  • src/ModularPipelines.Snyk/Enums/SnykReachabilityFilter.Generated.cs is excluded by !**/*.generated.*
  • src/ModularPipelines.Snyk/Enums/SnykSeverityThreshold.Generated.cs is excluded by !**/*.generated.*
  • src/ModularPipelines.Snyk/Enums/SnykShowVulnerablePaths.Generated.cs is excluded by !**/*.generated.*
  • src/ModularPipelines.Snyk/Generated/Snyk.Generation.json is excluded by !**/generated/**
📒 Files selected for processing (2)
  • src/ModularPipelines.Snyk/PublicAPI.Shipped.txt
  • src/ModularPipelines.Snyk/PublicAPI.Unshipped.txt
💤 Files with no reviewable changes (1)
  • src/ModularPipelines.Snyk/PublicAPI.Shipped.txt

Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The Snyk API tracking files update six enum definitions. Shipped declarations remove the affected members. Unshipped declarations record the old values as removed and add the new numeric values.

Changes

Snyk enum API updates

Layer / File(s) Summary
Update shipped API declarations
src/ModularPipelines.Snyk/PublicAPI.Shipped.txt
Removes the affected members from six Snyk enums while retaining the enum types and existing retained members.
Record enum value changes
src/ModularPipelines.Snyk/PublicAPI.Unshipped.txt
Records the previous enum values as removed and adds the renumbered values for the same members.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 93c5e

This updates Snyk enum API tracking to reflect the current CLI option ordering. The documented breaking enum-value changes are intentional, and no concrete merge-blocking risk remains.

Poem

A rabbit checks each enum line
Old numbers hop out of time
New numbers settle in a row
The API records the flow
Six Snyk enums now align

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: an automated update to the Snyk CLI options.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch automated/update-cli-options-snyk

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@thomhurst
thomhurst force-pushed the automated/update-cli-options-snyk branch from c5315a2 to 0902495 Compare September 6, 2026 07:25
@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Review: [Automated] Update snyk CLI Options (#4622)

This is a fully automated, generator-produced PR regenerating the Snyk CLI options classes from the latest scraped snyk CLI help output (v1.1306.1). I reviewed the diff, cross-referenced generated enums against their PublicAPI.Shipped.txt/Unshipped.txt entries, and checked for hand-edits to generated files.

Findings:

  • Enum member reordering (e.g. SnykCodeTestSeverityThreshold, SnykFailOn) changes ordinal values, which is a breaking change for anyone persisting/serializing these enums by numeric value. However, this reordering comes from pre-existing, documented generator policy (alphabetical ordering by CLI string in CliEnumDefinition.OrderValues), not something introduced or regressed by this PR — so it's expected/inherent to how the generator works, not an issue with this specific change.
  • Each [EnumValue("...")] attribute stays correctly paired with its original member name across all reordered enums — no accidental value/name swaps.
  • PublicAPI.Shipped.txt/Unshipped.txt updates correctly reflect every enum member whose ordinal changed (proper *REMOVED* + re-added entries), consistent with the assembly-wide API impact described in the PR body.
  • No hand-tweaking of generated output — complies with the repo's rule that generated options/enums must only be changed via the scraper/generator.
  • Generated files retain the correct <auto-generated> header and [GeneratedCode] attribute.

No correctness, design, or maintainability issues found. This is a clean, self-consistent mechanical regeneration — approved.

@thomhurst
thomhurst force-pushed the automated/update-cli-options-snyk branch from 0902495 to 097b708 Compare September 6, 2026 09:01
@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Review: [Automated] Update snyk CLI Options (#4622)

This is a fully automated, generator-produced PR that regenerates the Snyk CLI options classes from the latest scraped snyk CLI help output (v1.1306.1). All 9 changed files are generated artifacts: 6 *.Generated.cs enum files, Snyk.Generation.json, and PublicAPI.Shipped.txt/PublicAPI.Unshipped.txt.

What changed: Several enums (SnykCodeTestSeverityThreshold, SnykFailOn, SnykFilePathGroup, SnykReachabilityFilter, SnykSeverityThreshold, SnykShowVulnerablePaths) have had their members reordered, which shifts the underlying ordinal values (e.g. SnykSeverityThreshold.High goes from 2 to 1).

Verification performed:

  • The reordering matches CliEnumDefinition.OrderValues in the generator (tools/ModularPipelines.OptionsGenerator/.../Models/CliEnumDefinition.cs), which deliberately sorts enum values by their CLI string (case-insensitive) rather than scrape order, so this is expected, policy-driven generator behavior, not a regression introduced by this change.
  • Every [EnumValue("...")] attribute stays correctly paired with its original member name across all reordered enums — no accidental value/name swaps.
  • PublicAPI.Shipped.txt / PublicAPI.Unshipped.txt correctly reflect the ordinal shifts (old entries removed from Shipped, matching *REMOVED* + re-added entries in Unshipped), consistent with the breaking-change summary in the PR description.
  • No hand-tweaking of generated output — consistent with this repo's rule that generated options/enums are fixed via the scraper/generator only, never edited directly in a PR.
  • Generated files retain the correct <auto-generated> header and [GeneratedCode] attribute.

Per project convention, current tool output is treated as the source of truth even when regeneration causes breaking API changes (ordinal changes to public enums here), so this is acceptable as-is. No correctness, design, or maintainability issues found — this is a clean, self-consistent mechanical regeneration.

@thomhurst
thomhurst enabled auto-merge (squash) September 6, 2026 09:51
@thomhurst
thomhurst disabled auto-merge September 6, 2026 14:12
@thomhurst
thomhurst force-pushed the automated/update-cli-options-snyk branch from 097b708 to 93c5e65 Compare September 6, 2026 14:14
@github-actions

github-actions Bot commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

Review: [Automated] Update snyk CLI Options (#4622)

This is a fully automated, generator-produced PR regenerating the Snyk CLI options classes from the latest scraped snyk CLI help output. All changed files are generated artifacts:

  • 6 *.Generated.cs enum files (SnykCodeTestSeverityThreshold, SnykFailOn, SnykFilePathGroup, SnykReachabilityFilter, SnykSeverityThreshold, SnykShowVulnerablePaths) — members reordered alphabetically by their [EnumValue] CLI string.
  • src/ModularPipelines.Snyk/Generated/Snyk.Generation.json — only generatorSourceSha256 changed (CLI toolVersion/commandTreeSha256 unchanged), confirming this regeneration was triggered by a generator-source change, not a Snyk CLI version bump.
  • PublicAPI.Shipped.txt / PublicAPI.Unshipped.txt — mechanically regenerated to match the enum ordinal shifts.

Verification performed:

  • Every [EnumValue("...")] string attribute is preserved unchanged across the reorder — only enum member declaration order (and thus ordinals) changed, consistent with the generator's alphabetical OrderValues policy, not a regression introduced by this PR.
  • No source in the repo (production, tests, or docs) references these enums by numeric/ordinal value — all usages (test/ModularPipelines.Snyk.UnitTests/Attributes/SnykOptionsTests.cs, docs/docs/mp-packages/snyk.md) reference members by name and assert the CLI string via [EnumValue], so the reorder has no functional effect within this codebase.
  • PublicAPI.Shipped.txt/Unshipped.txt diffs are internally consistent (removed/added entries correctly paired per enum member).
  • No hand-tweaking of generated output — complies with this repo's rule that generated options/enums are only changed via the scraper/generator, never edited directly in a PR.

The ordinal renumbering is a breaking change for anyone persisting/serializing these enums by integer value, but per CLAUDE.md's explicit policy, current tool/generator output is the source of truth even when regeneration causes breaking API changes — and the PR description already discloses this. This matches the findings of the prior automated reviews on this PR, and no new issues were introduced in the current head.

No correctness, design, or maintainability issues found. This is a clean, self-consistent mechanical regeneration — approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant