docs(cli): document --project-tags for snyk code test#1311
Open
apzuk3 wants to merge 1 commit into
Open
Conversation
Adds a `--project-tags` option section to the `snyk code test` command reference, matching the wording already used for `snyk monitor`, `snyk container monitor`, and `snyk iac test`. The flag is implemented in the CLI (wired through code-client-go) but was not yet documented for `snyk code test`. The CLI repo's help/cli-commands content is synced from this user-docs source, so this change keeps both in sync.
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
9 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
--project-tagsoption section to thesnyk code testcommand reference, matching the wording already used forsnyk monitor,snyk container monitor, andsnyk iac test.The flag is already implemented in the CLI (wired through
code-client-go) but was not documented forsnyk code test.Where reviewer should start
developer-tools/snyk-cli/commands/code-test.mddocs/developer-tools/snyk-cli/commands/code-test.mdBoth copies are updated to keep the duplicates in sync. The new section is inserted after
--target-referenceand before--remote-repo-url, alongside the other report/project metadata options.Risk
Low - documentation only, no behaviour changes.
Companion PR
CLI repo: snyk/cli#6879 - adds the same section to
cli/help/cli-commands/code-test.mdsosnyk code test --helpreflects the change immediately. This user-docs PR is required because the CLI repo content is synced from this source weekly via.github/workflows/sync-cli-help-to-user-docs.yml; without this PR, the CLI change would be reverted by the next sync.