Skip to content

Make EACCES when installing CodeQL CLI a ConfigurationError - #4098

Merged
mbg merged 2 commits into
mainfrom
mbg/permission-error-as-configuration-error
Aug 14, 2026
Merged

Make EACCES when installing CodeQL CLI a ConfigurationError#4098
mbg merged 2 commits into
mainfrom
mbg/permission-error-as-configuration-error

Conversation

@mbg

@mbg mbg commented Aug 14, 2026

Copy link
Copy Markdown
Member

If we can't install the CodeQL CLI because the path is not writeable for the Action, then this is a configuration issue. The path should either be writeable for the Action or the CLI should be installed already. This PR adds a check for EACCES errors to classify them as ConfigurationErrors similar to what we already have for ENOSPC.

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?

Workflow types:

  • Advanced setup - Impacts users who have custom CodeQL workflows.
  • Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...).

Products:

  • Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.
  • Code Quality - The changes impact analyses when analysis-kinds: code-quality.
  • Other first-party - The changes impact other first-party analyses.
  • Third-party analyses - The changes affect the upload-sarif action.

Environments:

  • Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency.
  • GHES - Impacts CodeQL workflows on 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.

Are there any special considerations for merging or releasing this change?

  • No special considerations - This change can be merged at any time.

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 self-assigned this Aug 14, 2026
@mbg
mbg requested a review from a team as a code owner August 14, 2026 10:59
Copilot AI balanced review requested due to automatic review settings August 14, 2026 10:59
@github-actions github-actions Bot added the size/S Should be easy to review label Aug 14, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Warning

  • Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.

Pull request overview

Classifies CodeQL CLI installation permission failures as configuration errors.

Changes:

  • Detects EACCES alongside ENOSPC.
  • Adds unit tests for matching and non-matching errors.
Show a summary per file
File Description
src/codeql.ts Adds disk configuration-error classification.
src/codeql.test.ts Tests error classification behavior.
lib/entry-points.js Generated JavaScript artifact; excluded from review.

Review details

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Files excluded by content exclusion policy (1)
  • lib/entry-points.js
  • Files reviewed: 2/3 changed files
  • Comments generated: 0
  • Review effort level: Balanced

@mbg
mbg added this pull request to the merge queue Aug 14, 2026
Merged via the queue into main with commit d97b342 Aug 14, 2026
222 checks passed
@mbg
mbg deleted the mbg/permission-error-as-configuration-error branch August 14, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Should be easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants