Skip to content

Create wrapper runCliJson#3981

Open
mario-campos wants to merge 2 commits into
mainfrom
mario-campos/runCliJson
Open

Create wrapper runCliJson#3981
mario-campos wants to merge 2 commits into
mainfrom
mario-campos/runCliJson

Conversation

@mario-campos

Copy link
Copy Markdown
Contributor

Summary

A few of the CLI commands emit JSON. This PR creates a runCli wrapper function called runCliJson that expects JSON output from the CLI command. This change centralizes and reduces the number of JSON-parsing call sites in codeql.ts, making the code more readable and D.R.Y.er.

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

@mario-campos mario-campos requested a review from a team as a code owner July 1, 2026 04:03
Copilot AI review requested due to automatic review settings July 1, 2026 04:03
@github-actions github-actions Bot added the size/S Should be easy to review label Jul 1, 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

This PR introduces a runCliJson helper in src/codeql.ts to standardize “run CLI command + parse JSON output” behavior, reducing duplicated JSON.parse logic across CodeQL CLI wrapper methods.

Changes:

  • Add a generic runCliJson<T> wrapper around runCli that parses JSON output.
  • Refactor several CodeQL wrapper methods (e.g., resolve languages, resolve build-environment, resolve queries, resolve database, version) to use runCliJson instead of inlined parsing.
Show a summary per file
File Description
src/codeql.ts Adds runCliJson and refactors multiple CLI wrapper methods to centralize JSON parsing.
lib/entry-points.js Generated JS output update (content excluded from diff; also not generally reviewed for lib/).

Review details

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

Comment thread src/codeql.ts Outdated
Comment thread src/codeql.ts
@mario-campos mario-campos force-pushed the mario-campos/runCliJson branch from 3f66d8e to 6cdc606 Compare July 1, 2026 04:07
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.

2 participants