Update documentation to reflect changes in CodeQL Wrapper #81
Conversation
…d requirements, including new GitInfo class, updated Python version requirement, and enhanced CLI options for analyzing changed files in monorepos.
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for CodeQL Wrapper to reflect recent changes and improvements to the tool. The updates include raising the minimum Python version requirement, adding new CLI features, and providing more comprehensive CI/CD integration examples.
- Updated minimum Python version requirement from 3.8.1 to 3.9 across all documentation
- Added new CLI parameters and features including
--only-changed-files,--max-workers,--build-mode,--build-script, and--queries - Enhanced CI/CD integration documentation with working examples and updated pipeline configurations for GitHub Actions, Harness, Azure DevOps, and CircleCI
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/docs/intro.md | Updated Python version requirement and added trailing newlines |
| docs/docs/installation.md | Updated Python version requirements and removed tests/ from linting command |
| docs/docs/cli-usage.md | Added new CLI parameters, updated upload-sarif command signature, and added Kotlin language support |
| docs/docs/cicd-integration.md | Major updates to CI/CD examples with working implementations and simplified command syntax |
| docs/docs/api.md | Updated API documentation with new classes, parameters, and examples reflecting recent code changes |
|
|
||
| # Linting | ||
| poetry run flake8 src/ tests/ | ||
| poetry run flake8 src/ |
There was a problem hiding this comment.
The removal of 'tests/' from the flake8 command should be explained or justified. If tests are no longer being linted, this could impact code quality. Consider adding a comment explaining why tests are excluded or if this should be a separate command.
| poetry run flake8 src/ | |
| poetry run flake8 src/ tests/ |
| codeql-wrapper analyze /path/to/monorepo --monorepo --only-changed-files | ||
|
|
||
| # Analyze with a custom build script and specific queries | ||
| codeql-wrapper analyze /path/to/monorepo --monorepo --build-script ./build.sh --queries security-and-quality,my-custom-queries |
There was a problem hiding this comment.
The example shows 'security-and-quality,my-custom-queries' as query values, but it's unclear if these are actual valid query suite names or just examples. Consider using more concrete examples of actual CodeQL query suites or clarify that these are placeholder values.
| codeql-wrapper analyze /path/to/monorepo --monorepo --build-script ./build.sh --queries security-and-quality,my-custom-queries | |
| codeql-wrapper analyze /path/to/monorepo --monorepo --build-script ./build.sh --queries codeql-suites/javascript-security-and-quality.qls,codeql-suites/cpp-security-and-quality.qls |
No description provided.