Prevent GitHubClient types from being bundled (#81)

* Prevent `GitHubClient` types from being bundled

* just use structural typing

* add changeset

* fmt

Author: Andarist

.changeset/curvy-lies-walk.md

@@ -0,0 +1,5 @@
+---
+"@changesets/ghcommit": patch
+---
+
+Fixed an issue that caused GitHub types being bundled into the package and thus creating type incompatibilities in the dependent projects.

package.json

@@ -64,8 +64,6 @@
     "@changesets/changelog-github": "^0.5.1",
     "@changesets/cli": "^2.27.7",
     "@graphql-codegen/cli": "^7.0.0",
-    "@octokit/core": "^6.1.2",
-    "@octokit/graphql": "^8.1.1",
     "@tsconfig/node22": "^22.0.5",
     "@types/node": "^20.11.24",
     "dotenv": "^16.4.5",

pnpm-lock.yaml

@@ -1,6 +1,37 @@
-export type GitHubClient = ReturnType<
-  typeof import("@actions/github").getOctokit
->;
+// Octokit types are messy. To avoid adding any (peer)dependencies we rely on TS structural typing here
+export type GitHubClient = {
+  graphql: <T>(
+    query: string,
+    variables?: Record<string, unknown>,
+  ) => Promise<T>;
+  rest: {
+    git: {
+      createRef: (params: {
+        owner: string;
+        repo: string;
+        ref: string;
+        sha: string;
+      }) => Promise<{ data: { node_id?: string } }>;
+      updateRef: (params: {
+        owner: string;
+        repo: string;
+        ref: string;
+        sha: string;
+        force?: boolean;
+      }) => Promise<{ data: { node_id?: string } }>;
+      deleteRef: (params: {
+        owner: string;
+        repo: string;
+        ref: string;
+      }) => Promise<unknown>;
+      getRef?: (params: {
+        owner: string;
+        repo: string;
+        ref: string;
+      }) => Promise<unknown>;
+    };
+  };
+};
 
 import type {
   CreateCommitOnBranchMutation,

src/github/graphql/queries.ts

@@ -14,6 +14,9 @@ export default defineConfig({
   exports: false,
   // useful for running `build --watch` and `test` concurrently
   clean: !process.argv.includes("--watch"),
+  deps: {
+    onlyBundle: [], // require explicitly listing inlined dependencies
+  },
 
   sourcemap: !isCi,
   dts: { enabled: true, parallel: !isCi, sourcemap: !isCi },