Remove log argument (#110)

Author: bluwy

.changeset/tidy-chefs-bake.md

@@ -0,0 +1,5 @@
+---
+"@changesets/ghcommit": major
+---
+
+Remove `log` argument from APIs. If you need to debug the package, use breakpoints or manually add logs in the package code.

.env.example

@@ -1,6 +1,3 @@
-# needed got pnpm test:ci
+# needed for pnpm test:integration
 GITHUB_TOKEN='<...some token>'
 GITHUB_REPOSITORY=changesets/ghcommit
-
-# Debug Logging
-# RUNNER_DEBUG=1

README.md

@@ -73,7 +73,6 @@ All the functions below accept a single object as its argument, and share the fo
    * The commit message
    */
   message: string | CommitMessage;
-  log?: Logger;
 }
 ```
 

package.json

@@ -59,8 +59,6 @@
     "oxfmt": "^0.53.0",
     "oxlint": "^1.68.0",
     "oxlint-tsgolint": "^0.23.0",
-    "pino": "^9.3.2",
-    "pino-pretty": "^11.2.2",
     "publint": "^0.3.21",
     "tsdown": "^0.22.1",
     "typescript": "^6.0.3",

pnpm-lock.yaml

@@ -84,20 +84,17 @@ export const commitFilesFromBase64 = async ({
   force = false,
   message,
   fileChanges,
-  log,
 }: CommitFilesFromBase64Args): Promise<CommitFilesResult> => {
   const repositoryNameWithOwner = `${owner}/${repo}`;
   const baseRef = getBaseRef(base);
   const targetRef = `refs/heads/${branch}`;
 
-  log?.debug(`Getting repo info ${repositoryNameWithOwner}`);
   const info = await getRepositoryMetadata(octokit, {
     owner,
     repo,
     baseRef,
     targetRef,
   });
-  log?.debug(`Repo info: ${JSON.stringify(info, null, 2)}`);
 
   if (!info) {
     throw new Error(
@@ -181,7 +178,6 @@ export const commitFilesFromBase64 = async ({
       tempRefId = refIdStr;
     }
 
-    log?.debug(`Creating commit on branch ${tempBranch}`);
     const tempCommit = await createCommit({
       octokit,
       refId: tempRefId,
@@ -244,7 +240,6 @@ export const commitFilesFromBase64 = async ({
     refId = sameBranchBase ? resolvedBaseRef!.id : info.targetBranch!.id;
   }
 
-  log?.debug(`Creating commit on branch ${branch}`);
   const newCommit = await createCommit({
     octokit,
     refId,

src/core.ts

@@ -3,7 +3,6 @@ import type {
   FileChanges,
 } from "./github/graphql/generated/types.ts";
 import type { GitHubClient } from "./github/graphql/queries.ts";
-import type { Logger } from "./logging.ts";
 
 export type CommitFilesResult = {
   refId: string | null;
@@ -34,7 +33,6 @@ export interface CommitFilesBasedArgs {
    * The commit message
    */
   message: string | CommitMessage;
-  log?: Logger;
 }
 
 export interface CommitFilesSharedArgsWithBase extends CommitFilesBasedArgs {

src/interface.ts

@@ -1,6 +1,5 @@
 import crypto from "node:crypto";
 import { getOctokit } from "@actions/github";
-import { pino } from "pino";
 import { expect } from "vitest";
 import {
   deleteRefMutation,
@@ -13,13 +12,6 @@ export const [owner, repo] = process.env.GITHUB_REPOSITORY!.split("/")!;
 
 export const octokit = getOctokit(githubToken);
 
-export const log = pino({
-  level: process.env.RUNNER_DEBUG === "1" ? "debug" : "info",
-  transport: {
-    target: "pino-pretty",
-  },
-});
-
 /**
  * GitHub sometimes has a delay between making changes to a git repo,
  * and those changes being reflected in the API.