-
Notifications
You must be signed in to change notification settings - Fork 412
Update wording in some log messages #3227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates log messages throughout the CodeQL Action codebase to improve accuracy and reflect that the Action can be used in different contexts beyond Code Scanning. Key terminology changes include replacing "Code Scanning API" with "CodeQL Action API" and generalizing references from "Code Scanning" to "CodeQL" where appropriate.
Key Changes
- Updated API endpoint references from "Code Scanning API" to "CodeQL Action API" in feature flag loading and status reporting
- Changed permission guidance from referencing "the Action" to "the workflow" with more accurate permission requirements (
security-events: readinstead ofsecurity-events: write) - Generalized product-specific references from "Code Scanning" to "CodeQL" in user-facing messages
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/status-report.ts | Updated error messages to reference CodeQL Action API endpoints, improved permission guidance, added backticks to codeql-action references, and generalized product terminology |
| src/feature-flags.ts | Updated debug and warning messages to reference CodeQL Action API instead of Code Scanning API, improved permission guidance |
| lib/upload-sarif-action.js | Generated JavaScript reflecting TypeScript changes in feature flags and status reporting |
| lib/start-proxy-action.js | Generated JavaScript reflecting TypeScript changes in status reporting |
| lib/setup-codeql-action.js | Generated JavaScript reflecting TypeScript changes in feature flags and status reporting |
| lib/resolve-environment-action.js | Generated JavaScript reflecting TypeScript changes in status reporting |
| lib/init-action.js | Generated JavaScript reflecting TypeScript changes in feature flags and status reporting |
| lib/init-action-post.js | Generated JavaScript reflecting TypeScript changes in feature flags and status reporting |
| lib/autobuild-action.js | Generated JavaScript reflecting TypeScript changes in feature flags and status reporting |
| lib/analyze-action.js | Generated JavaScript reflecting TypeScript changes in feature flags and status reporting |
8be6813 to
40b4cdd
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
For loose fixes like these I find that copilot has a pretty good hit rate when asked to find places to do similar fixes.
This PR just updates some log messages to be more accurate to reflect that the CodeQL Action can be used in different contexts.
Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
analysis-kinds: code-scanning).analysis-kinds: code-quality).upload-sarif).How did/will you validate this change?
.test.tsfiles).pr-checks).If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
Merge / deployment checklist