Skip to content

Fix OIDC credential property names#3807

Open
mbg wants to merge 2 commits intomainfrom
mbg/start-proxy/fix-field-names
Open

Fix OIDC credential property names#3807
mbg wants to merge 2 commits intomainfrom
mbg/start-proxy/fix-field-names

Conversation

@mbg
Copy link
Copy Markdown
Member

@mbg mbg commented Apr 9, 2026

Fixes an oversight in #3563. The JSON property names use - instead of _.

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:

  • 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?

  • Test repository - This change will be tested on a test repository before merging.
  • 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 Apr 9, 2026
Copilot AI review requested due to automatic review settings April 9, 2026 16:50
@mbg mbg requested a review from a team as a code owner April 9, 2026 16:50
@github-actions github-actions bot added the size/M Should be of average difficulty to review label Apr 9, 2026
Copy link
Copy Markdown
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 corrects the JSON property names used for OIDC credential configurations in the start-proxy action, switching from underscore-separated keys to hyphen-separated keys to match the expected schema.

Changes:

  • Update OIDC config types and validators (Azure/AWS/JFrog) to use hyphenated JSON keys.
  • Update getAuthConfig and credential pretty-printing to read/write the new keys.
  • Update unit tests to use the new key names (and regenerate lib/ output).
Show a summary per file
File Description
src/start-proxy/types.ts Switches OIDC config typing/validation and pretty-printing to hyphenated JSON property names.
src/start-proxy/types.test.ts Updates fixtures/expectations for OIDC credential string formatting with new keys.
src/start-proxy.ts Updates getAuthConfig normalization/output for OIDC configs to use hyphenated keys.
src/start-proxy.test.ts Updates OIDC test fixtures to use the new hyphenated keys.
lib/start-proxy-action.js Generated build output reflecting the TypeScript changes.

Copilot's findings

  • Files reviewed: 4/5 changed files
  • Comments generated: 3

henrymercer
henrymercer previously approved these changes Apr 9, 2026
Copy link
Copy Markdown
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

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

Changelog note?

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.

3 participants