Log error for non-default analysis-kinds input outside of managed workflows - #3895
Merged
henrymercer merged 3 commits intoMay 19, 2026
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a clearer runtime error log when the internal-only analysis-kinds input is set to a non-default value in non–GitHub-managed (custom/advanced) workflows, and refactors test utilities to make it easier to set up Actions-like environment variables in unit tests.
Changes:
- Log an error outside of test mode when analysis-kinds enables anything other than code-scanning in non-managed workflows (detected via non-dynamic event).
- Centralize the “internal-only / experimental” analysis-kinds preamble into a shared helper for consistent messaging.
- Split test env setup into setupBaseActionsVars vs. setupActionsVars, and update tests accordingly.
| File | Description |
|---|---|
| src/testing-utils.ts | Introduces setupBaseActionsVars and a shared override type to simplify environment setup in unit tests. |
| src/analyses.ts | Adds custom-workflow detection and logs an error for non-default analysis-kinds; refactors repeated error prefix into a helper. |
| src/analyses.test.ts | Updates tests to set required Actions env vars and adds coverage for the new “custom vs managed workflow” logging behavior. |
| lib/setup-codeql-action.js | Generated output updated to reflect the TypeScript changes. |
| lib/init-action.js | Generated output updated to reflect the TypeScript changes. |
Copilot's findings
- Files reviewed: 3/5 changed files
- Comments generated: 0
Sorry, something went wrong.
henrymercer
previously approved these changes
May 19, 2026
Comment thread
src/analyses.test.ts
Outdated
Comment on lines
+129
to
+131
| !logger.hasMessage( | ||
| "An analysis kind other than `code-scanning` was specified in a custom workflow.", | ||
| ), |
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Nit, optional: this isn't robust to the message changing slightly — it would be more robust to assert what is logged.
Sorry, something went wrong.
…rn-on-non-cs-advanced-setup
henrymercer
approved these changes
May 19, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
May 19, 2026
This was referenced May 22, 2026
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.
The analysis-kinds input is for internal-use only and non-default arguments outside of GitHub-managed workflows are not supported. This PR logs an error if we detect that a (meaningful) value other than code-scanning (the default) is provided, along with instructions for the intended way of enabling e.g. other queries.
Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Workflow types:
Products:
Environments:
How did/will you validate this change?
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?
Are there any special considerations for merging or releasing this change?
Merge / deployment checklist