Skip to content

Change DEFAULT_CONFIG_FILE_NAME - #4070

Merged
mbg merged 1 commit into
mainfrom
mbg/remote-address/change-file-default
Aug 3, 2026
Merged

Change DEFAULT_CONFIG_FILE_NAME#4070
mbg merged 1 commit into
mainfrom
mbg/remote-address/change-file-default

Conversation

@mbg

@mbg mbg commented Aug 3, 2026

Copy link
Copy Markdown
Member

Changes DEFAULT_CONFIG_FILE_NAME to a saner default value that aligns with the path we suggest in most docs. Although this has already shipped with the old value, we accept that usage is zero right now and that improving the default is better in the long run.

We deliberately do not put any mitigations in place to avoid additional API requests.

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.

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 requested a review from coadaflorin August 3, 2026 14:05
@mbg mbg self-assigned this Aug 3, 2026
Copilot AI review requested due to automatic review settings August 3, 2026 14:05
@mbg
mbg requested a review from a team as a code owner August 3, 2026 14:05
@github-actions github-actions Bot added the size/XS Should be very easy to review label Aug 3, 2026
@mbg
mbg enabled auto-merge August 3, 2026 14:07

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

Updates the default remote CodeQL configuration path to match the commonly documented convention.

Changes:

  • Changes the shorthand default to .github/codeql-config.yml.
  • Includes the generated JavaScript artifact.
Show a summary per file
File Description
src/config/remote-file.ts Updates the default configuration path.
lib/entry-points.js Content excluded by organization policy.

Review details

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

Comment thread src/config/remote-file.ts
@mbg
mbg added this pull request to the merge queue Aug 3, 2026
Merged via the queue into main with commit 6a9359a Aug 3, 2026
223 checks passed
@mbg
mbg deleted the mbg/remote-address/change-file-default branch August 3, 2026 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Should be very easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants