docs: clarify CLI version check#6915
Draft
bgardiner wants to merge 1 commit into
Draft
Conversation
Co-authored-by: bgardiner <bgardiner@users.noreply.github.com>
✅ 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. |
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
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.
Pull Request Submission Checklist
What does this PR do?
Adds a short note to the README showing
snyk --versionas a way to confirm which CLI release is installed. This is a documentation-only change intended to trigger CI on a pull request.Risk assessment: Low.
Where should the reviewer start?
README.mdHow should this be manually tested?
No manual testing is required for this documentation-only change.
Validation performed:
npx prettier --check README.mdBUILD_MODE=public make lint(TypeScript linting, formatting checks, and Go linting completed; final tidy verification failed because this cloud environment cannot access the privategithub.com/snyk/remy-cli-extensionmodule.)What's the product update that needs to be communicated to CLI users?
None.