Fixed documentation and version checks #7
Merged
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.
Description
The
.hooks/version-check.pyscript was not updating all documentation files when the version changed. Several documentation files contained outdated CLI parameter examples and version references (e.g.,--python-sast-enabledinstead of--python,--secret-scanning-enabledinstead of--secrets), and some files likeblog.md,docs/local-install-docker.md, anddocs/version-management.mdwere not included in the version update process at all.Root Cause
The
README_FILESlist in.hooks/version-check.pyonly included 3 files (README.md, docs/github-action.md, docs/pre-commit-hook.md), missing several other documentation files that contain version references. Additionally, the regex patterns for matching Docker commands and image references were too narrow and didn't handle:--platformflagsmyorg/security-scanner)Fix
Expanded
README_FILESlist to include all documentation files with version references:blog.mddocs/local-install-docker.mddocs/version-management.mddocs/parameters.md(new comprehensive parameters reference)Enhanced regex patterns in version-check.py:
DOCKER_BUILD_PATTERNto handle--platformflags and existing version tagsIMAGE_VERSION_PATTERNto match standalone image references (e.g., indocker runcommands)Updated all documentation with correct CLI examples:
docs/parameters.mdwith all current CLI options and environment variablesdocs/local-install-docker.mdexamples to use current parameters (--python,--javascript,--secrets,--all-languages,--socket-tier1,--images, etc.)Fixed incorrect Docker syntax in local-install-docker.md (removed invalid
:latestafter version tag)All version references and CLI examples are now automatically updated by the version-check script and match the actual current CLI options.
Public Changelog
N/A