KEMBAR78
Allow `Partial<Config>` for `createStatusReportBase` by mbg · Pull Request #3188 · github/codeql-action · GitHub
Skip to content

Conversation

@mbg
Copy link
Member

@mbg mbg commented Oct 8, 2025

This PR changes the type of createStatusReportBase to allow Partial<Config> | undefined rather than Config | undefined. The unit tests for createStatusReportBase are updated accordingly. I then made use of this to populate the languages field in the start-proxy telemetry.

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?

  • Default setup - Impacts users who use default setup.
  • Code Scanning - Impacts Code Scanning (i.e. analysis-kinds: code-scanning).
  • Code Quality - Impacts Code Quality (i.e. analysis-kinds: code-quality).
  • 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.

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 marked this pull request as ready for review October 8, 2025 12:06
@mbg mbg requested a review from a team as a code owner October 8, 2025 12:06
@mbg mbg requested review from Copilot and henrymercer October 8, 2025 12:06
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 refactors the createStatusReportBase function to accept Partial<Config> instead of Config, enabling more flexible usage when only partial configuration data is available. The changes improve telemetry by allowing the start-proxy action to report language information even when a full configuration isn't available.

  • Updates createStatusReportBase function signature to accept Partial<Config> | undefined
  • Adds null-safe access operators for config properties to handle partial configurations
  • Modifies start-proxy action to populate language information in telemetry reports

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.

Show a summary per file
File Description
src/status-report.ts Updates function signature and adds null-safe property access
src/status-report.test.ts Adds test coverage for empty and partial configuration scenarios
src/start-proxy.ts Refactors getCredentials to accept KnownLanguage directly
src/start-proxy.test.ts Updates test calls to pass KnownLanguage enum values
src/start-proxy-action.ts Implements language parsing and telemetry reporting with partial config
lib/*.js Generated JavaScript files reflecting the TypeScript changes

@mbg mbg force-pushed the mbg/telemetry/partial-config branch from 25db0e9 to bdd2cdf Compare October 8, 2025 12:13
@mbg mbg merged commit 196a3e5 into main Oct 8, 2025
242 checks passed
@mbg mbg deleted the mbg/telemetry/partial-config branch October 8, 2025 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants