Skip to content

Use ComputedInput for configuration file input#4045

Draft
mbg wants to merge 6 commits into
mainfrom
mbg/use-computed-input
Draft

Use ComputedInput for configuration file input#4045
mbg wants to merge 6 commits into
mainfrom
mbg/use-computed-input

Conversation

@mbg

@mbg mbg commented Jul 24, 2026

Copy link
Copy Markdown
Member

Modifies getConfigFileInput to:

  1. Return a ComputedInput value that we can report in telemetry, rather than just the computed value itself.
  2. Use a generalised getComputedInput function extracted from getToolsInput.

A secondary change is the introduction of a nonEmptyStringProperty so that we can make this explicit in repositoryPropertyParsers rather than dealing with empty strings everywhere downstream.

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?

  • Feature flags - All new or changed code paths can be fully disabled with corresponding feature flags.
  • 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 Jul 24, 2026
@github-actions github-actions Bot added the size/M Should be of average difficulty to review label Jul 24, 2026
@mbg mbg changed the title Use ComputedInput for other applicable inputs Use ComputedInput for configuration file input Jul 24, 2026
@mbg
mbg requested a review from Copilot July 24, 2026 16:36

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

Generalizes computed input handling so config-file values and sources can be reported in telemetry.

Changes:

  • Extracts reusable computed-input resolution.
  • Tracks config-file values and sources in status reports.
  • Adds non-empty repository-property validation.
Show a summary per file
File Description
src/config/inputs.ts Generalizes computed-input resolution.
src/config/file.ts Returns computed config-file input metadata.
src/config/file.test.ts Updates config-file input tests.
src/feature-flags/properties.ts Adds non-empty string validation.
src/init-action.ts Propagates config-file input metadata.
src/status-report.ts Reports the resolved config-file value.
lib/entry-points.js Generated output; excluded from review.

Review details

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

[K in RepositoryPropertyName]: PropertyInfo<K>;
} = {
[RepositoryPropertyName.CONFIG_FILE]: stringProperty,
[RepositoryPropertyName.CONFIG_FILE]: nonEmptyStringProperty,
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Should be of average difficulty to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants