Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Turn enablement errors into configuration errors #3251

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 29, 2025
Merged

Turn enablement errors into configuration errors #3251

merged 3 commits into from
Oct 29, 2025

Conversation

@mbg
Copy link
Member

@mbg mbg commented Oct 28, 2025

This PR adds more cases to wrapApiConfigurationError where we want specific errors to be treated as ConfigurationErrors.

Risk assessment

For internal use only. Please select the risk level of this change:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

  • Advanced setup - Impacts users who have custom workflows.
  • Default setup - Impacts users who use default setup.
  • Code Scanning - Impacts Code Scanning (i.e. analysis-kinds: code-scanning).
  • Third-party analyses - Impacts third-party analyses (i.e. upload-sarif).
  • GHES - Impacts GitHub Enterprise Server.

How did/will you validate this change?

  • Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).
  • End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

  • Telemetry - I rely on existing telemetry or have made changes to the telemetry.
    • Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.
    • Alerts - New or existing monitors will trip if something goes wrong with this change.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

@mbg mbg requested a review from a team as a code owner October 28, 2025 21:18
Copilot AI review requested due to automatic review settings October 28, 2025 21:18
@github-actions github-actions bot added the size/S Should be easy to review label Oct 28, 2025
Copilot AI reviewed Oct 28, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a 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 improves error handling for GitHub Security feature enablement errors by providing more user-friendly messages when features like Code Security, Advanced Security, or Code Scanning are not enabled.

Key changes:

  • Added an isEnablementError helper function to detect enablement-related error messages
  • Enhanced wrapApiConfigurationError to wrap enablement errors with clearer guidance
  • Added comprehensive test coverage for the three enablement error scenarios

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/api-client.ts Added isEnablementError helper and integrated enablement error checking into wrapApiConfigurationError
src/api-client.test.ts Added test cases for Code Security, Advanced Security, and Code Scanning enablement errors
lib/upload-sarif-action.js Generated JavaScript code from TypeScript source
lib/upload-lib.js Generated JavaScript code from TypeScript source
lib/setup-codeql-action.js Generated JavaScript code from TypeScript source
lib/init-action.js Generated JavaScript code from TypeScript source
lib/init-action-post.js Generated JavaScript code from TypeScript source
lib/analyze-action.js Generated JavaScript code from TypeScript source

esbena
esbena previously approved these changes Oct 29, 2025
View reviewed changes
Copy link
Contributor

@esbena esbena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with two minor things to consider.

src/api-client.test.ts
new util.ConfigurationError("Resource not accessible by integration"),
);

// Enablement errors.
Copy link
Contributor

@esbena esbena Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find the test messages a bit brittle since they do exact matching on the user-facing texts, but I find it unlikely to result in significant churn, so 👍🏻

Copy link
Member Author

@mbg mbg Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have wrapped this up in a function to avoid the duplication in case we want to change it down the line. Ideally, I would have put it in error-messages.ts but that currently (transitively) depends on api-client.ts and I didn't want to refactor that as part of this PR so I have left a TODO comment for it.

@mbg mbg requested a review from esbena October 29, 2025 08:37
@mbg mbg merged commit 34c50c1 into main Oct 29, 2025
243 checks passed
@mbg mbg deleted the mbg/user-error/enablement branch October 29, 2025 09:57
This was referenced Oct 30, 2025
Merged
Merged
@mbg mbg mentioned this pull request Oct 30, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@esbena esbena esbena approved these changes

Assignees

No one assigned

Labels

size/S Should be easy to review

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@mbg @esbena