FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Use Actions logger in API client by henrymercer · Pull Request #3249 · github/codeql-action · GitHub

Repository navigation

Use Actions logger in API client - #3249

Merged
henrymercer merged 4 commits into
mainfrom
henrymercer/api-logging
Oct 28, 2025
Merged

henrymercer merged 4 commits into
mainfrom
henrymercer/api-logging

Conversation

Copy link
Copy Markdown
Contributor

This allows us to remove the console-log-level dependency.

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?

  • Advanced setup - Impacts users who have custom workflows.
  • 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).
  • Third-party analyses - Impacts third-party analyses (i.e. upload-sarif).
  • 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.
    • Alerts - New or existing monitors will trip if something goes wrong with this change.

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.

henrymercer requested a review from a team as a code owner October 28, 2025 13:02
Copilot AI review requested due to automatic review settings October 28, 2025 13:02
github-actions Bot added the size/XS Should be very easy to review label Oct 28, 2025

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Pull Request Overview

This PR replaces the console-log-level logger with the native @actions/core logger in the API client, allowing the removal of the console-log-level dependency. Additionally, the PR improves the check-node-modules.sh script to handle more installation scenarios.

Key changes:

  • Switched from console-log-level to @actions/core for Octokit logging
  • Removed the console-log-level dependency from package.json
  • Enhanced the check-node-modules.sh script with additional checks

Reviewed Changes

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

File Description
src/api-client.ts Replaced console-log-level logger with Actions core logger using spread syntax and aliased warn to core.warning
package.json Removed console-log-level dependency
scripts/check-node-modules.sh Added checks for missing node_modules, outdated package.json, and improved messaging
lib/*.js (multiple files) Generated JavaScript files reflecting the TypeScript changes and dependency removal

mbg previously approved these changes Oct 28, 2025
Comment thread src/api-client.ts
Comment on lines +52 to +55
log: {
...core,
warn: core.warning,
},

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Minor: it might be good to set all the properties explicitly rather than include the entire core object, in case it ever changes. We'd probably want to know if that happens.

github-actions Bot added size/S Should be easy to review and removed size/XS Should be very easy to review labels Oct 28, 2025
henrymercer requested a review from mbg October 28, 2025 16:53
henrymercer enabled auto-merge October 28, 2025 16:55
henrymercer merged commit ac9aeee into main Oct 28, 2025
henrymercer deleted the henrymercer/api-logging branch October 28, 2025 17:06
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.

3 participants


Back | FazBrowse Home | New Git URL