Skip to content

docs: synchronizing help from snyk/user-docs - #7188

Open
team-cli-bot wants to merge 1 commit into
mainfrom
docs/automatic-gitbook-update-cli-help-main
Open

team-cli-bot wants to merge 1 commit into
mainfrom
docs/automatic-gitbook-update-cli-help-main

Conversation

@team-cli-bot

@team-cli-bot team-cli-bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Automatic PR controlled by GitHub Action


Note

Low Risk
Documentation-only markdown formatting sync with no runtime or security impact.

Overview
This PR syncs CLI help markdown from snyk/user-docs (automated GitHub Action) and only adjusts Markdown escaping—no CLI behavior or option semantics change.

Across code test, container test, iac test, test, sbom test, and log4shell help, exit code 1 is now documented as action\_needed instead of action_needed, so underscores are not interpreted as emphasis when rendered.

SARIF docs in code-test, iac-test, and test now escape the placeholder as OUTPUT\_FILE\_PATH. The ignore examples for IaC resource paths escape underscores in displayed paths (e.g. aws\_iam\_role, assume\_role\_policy) for the same rendering reason.

Reviewed by Cursor Bugbot for commit 3115718. Bugbot is set up for automated code reviews on this repo. Configure here.

@team-cli-bot
team-cli-bot requested a review from a team as a code owner August 31, 2026 09:12
@snyk-io

snyk-io Bot commented Aug 31, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor
Warnings
⚠️

Please make changes to snyk help text in Gitbook. Changes will be automatically synchronised to Snyk CLI as a scheduled PR.
For more information, see: help/README.md.

Generated by 🚫 dangerJS against 3115718

@snyk-pr-review-bot

This comment has been minimized.

@team-cli-bot
team-cli-bot force-pushed the docs/automatic-gitbook-update-cli-help-main branch from 96baeec to 16432f9 Compare September 7, 2026 09:12
@snyk-pr-review-bot

This comment has been minimized.

@team-cli-bot
team-cli-bot force-pushed the docs/automatic-gitbook-update-cli-help-main branch from 16432f9 to b79bac9 Compare September 14, 2026 09:12
@snyk-pr-review-bot

This comment has been minimized.

@team-cli-bot
team-cli-bot force-pushed the docs/automatic-gitbook-update-cli-help-main branch from b79bac9 to 3115718 Compare September 17, 2026 11:32
@snyk-pr-review-bot

Copy link
Copy Markdown

PR Reviewer Guide 🔍

🧪 PR contains tests
🔒 No security concerns identified
⚡ No major issues detected
📚 Repository Context Analyzed

This review considered 22 relevant code sections from 10 files (average relevance: 0.55)

🤖 Repository instructions applied (from AGENTS.md)

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant