@tahminator/pipeline 1.0.73-beta.27d4efec → 1.0.73-beta.35856f4d

package/dist/gh/client.d.ts

@@ -1,14 +1,12 @@
 import { GitHubOutputManager } from "./output";
 import { GitHubPRManager } from "./pr";
 import { GitHubTagManager } from "./tag";
-import { GitHubTeamManager } from "./team";
 export declare class GitHubClient {
     private readonly client;
     private readonly isExplicitToken;
     private readonly tagManager;
     private readonly outputManager;
     private readonly prManager;
-    private readonly teamManager;
     private constructor();
     /**
      * @note `appId` can be `Client ID` or `App ID`. Hover over `appId` for more details.
@@ -41,6 +39,5 @@ export declare class GitHubClient {
     outputToGithubOutput(...args: Parameters<GitHubOutputManager["outputToGithubOutput"]>): Promise<void>;
     updateK8sTagWithPR(...args: Parameters<GitHubPRManager["updateK8sTagWithPR"]>): Promise<void>;
     sendPrMessage(...args: Parameters<GitHubPRManager["sendPrMessage"]>): Promise<void>;
-    mergePr(...args: Parameters<GitHubPRManager["mergePr"]>): Promise<void>;
-    isTeamMember(...args: Parameters<GitHubTeamManager["isTeamMember"]>): Promise<boolean>;
+    approvePr(...args: Parameters<GitHubPRManager["approvePr"]>): Promise<void>;
 }

package/dist/gh/client.js

@@ -3,21 +3,18 @@ import { Octokit } from "@octokit/rest";
 import { GitHubOutputManager } from "./output";
 import { GitHubPRManager } from "./pr";
 import { GitHubTagManager } from "./tag";
-import { GitHubTeamManager } from "./team";
 export class GitHubClient {
     client;
     isExplicitToken;
     tagManager;
     outputManager;
     prManager;
-    teamManager;
     constructor(client, isExplicitToken) {
         this.client = client;
         this.isExplicitToken = isExplicitToken;
         this.tagManager = new GitHubTagManager(this.client, this.isExplicitToken);
         this.outputManager = new GitHubOutputManager();
-        this.prManager = new GitHubPRManager(this.client);
-        this.teamManager = new GitHubTeamManager(this.client);
+        this.prManager = new GitHubPRManager(this.client, this.isExplicitToken);
     }
     /**
      * @note `appId` can be `Client ID` or `App ID`. Hover over `appId` for more details.
@@ -71,10 +68,7 @@ export class GitHubClient {
     sendPrMessage(...args) {
         return this.prManager.sendPrMessage(...args);
     }
-    mergePr(...args) {
-        return this.prManager.mergePr(...args);
-    }
-    isTeamMember(...args) {
-        return this.teamManager.isTeamMember(...args);
+    approvePr(...args) {
+        return this.prManager.approvePr(...args);
     }
 }

package/dist/gh/pr/index.d.ts

@@ -2,7 +2,9 @@ import type { Octokit } from "@octokit/rest";
 import type { Environment, OwnerString, RepoString } from "../../types";
 export declare class GitHubPRManager {
     private readonly client;
-    constructor(client: Octokit);
+    private readonly isExplicitToken;
+    constructor(client: Octokit, isExplicitToken: boolean);
+    private checkToken;
     /**
      *
      * update k8s manifest repo with new tag version.
@@ -34,20 +36,23 @@ export declare class GitHubPRManager {
         originRepo: [OwnerString, RepoString];
         manifestRepo: [OwnerString, RepoString];
     }): Promise<void>;
-    /**
-     * @note if the PR doesn't exist yet, just use `updateK8sTagWithPR` instead, since it
-     * creates the PR with the necessary changes and merges it for you in one call.
-     */
-    mergePr({ prId, owner, repository, mergeMethod, }: {
+    sendPrMessage({ prId, owner, repository, message, }: {
         prId: number;
         owner: string;
         repository: string;
-        mergeMethod?: "merge" | "squash" | "rebase";
+        message: string;
     }): Promise<void>;
-    sendPrMessage({ prId, owner, repository, message, }: {
+    /**
+     * Approves the given pull request.
+     *
+     * @note requires a token belonging to a user/app distinct from the PR author,
+     * since GitHub does not allow self-approval. As such, it is highly recommended to
+     * just use an app identity instead.
+     */
+    approvePr({ prId, owner, repository, message, }: {
         prId: number;
         owner: string;
         repository: string;
-        message: string;
+        message?: string;
     }): Promise<void>;
 }

package/dist/gh/pr/index.js

@@ -3,8 +3,15 @@ import { Utils } from "../../utils";
 import { kustomizeSchema } from "./schema";
 export class GitHubPRManager {
     client;
-    constructor(client) {
+    isExplicitToken;
+    constructor(client, isExplicitToken) {
         this.client = client;
+        this.isExplicitToken = isExplicitToken;
+    }
+    checkToken() {
+        if (!this.isExplicitToken) {
+            throw new Error("You must pass in an explicit GitHub token for this operation. You may either use a PAT or a GitHub App Token");
+        }
     }
     /**
      *
@@ -91,29 +98,35 @@ export class GitHubPRManager {
             base: baseBranch,
             body: `Automated image tag change to ${newTag} for ${imageName} in ${environment} triggered by [${originOwner}/${originRepository}](https://github.com/${originOwner}/${originRepository}).`,
         });
-        await this.mergePr({
-            prId: pr.number,
+        await this.client.rest.pulls.merge({
             owner: manifestOwner,
-            repository: manifestRepository,
+            repo: manifestRepository,
+            pull_number: pr.number,
+            merge_method: "squash",
         });
     }
-    /**
-     * @note if the PR doesn't exist yet, just use `updateK8sTagWithPR` instead, since it
-     * creates the PR with the necessary changes and merges it for you in one call.
-     */
-    async mergePr({ prId, owner, repository, mergeMethod = "squash", }) {
-        await this.client.rest.pulls.merge({
+    async sendPrMessage({ prId, owner, repository, message, }) {
+        await this.client.rest.issues.createComment({
+            issue_number: prId,
             owner,
             repo: repository,
-            pull_number: prId,
-            merge_method: mergeMethod,
+            body: message,
         });
     }
-    async sendPrMessage({ prId, owner, repository, message, }) {
-        await this.client.rest.issues.createComment({
-            issue_number: prId,
+    /**
+     * Approves the given pull request.
+     *
+     * @note requires a token belonging to a user/app distinct from the PR author,
+     * since GitHub does not allow self-approval. As such, it is highly recommended to
+     * just use an app identity instead.
+     */
+    async approvePr({ prId, owner, repository, message, }) {
+        this.checkToken();
+        await this.client.rest.pulls.createReview({
+            pull_number: prId,
             owner,
             repo: repository,
+            event: "APPROVE",
             body: message,
         });
     }

package/package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "author": "Tahmid Ahmed",
   "description": "A collection of Bun shell scripts that can be re-used in various CICD pipelines.",
-  "version": "1.0.73-beta.27d4efec",
+  "version": "1.0.73-beta.35856f4d",
   "repository": {
     "url": "git+https://github.com/tahminator/pipeline.git"
   },

package/dist/gh/team/index.d.ts

@@ -1,16 +0,0 @@
-import type { Octokit } from "@octokit/rest";
-export declare class GitHubTeamManager {
-    private readonly client;
-    constructor(client: Octokit);
-    /**
-     * Confirms whether the given user is an active member of a team within an org.
-     *
-     * @note this only returns `true` for `active` memberships. A user with a `pending`
-     * invite (has not accepted yet) will return `false`.
-     */
-    isTeamMember({ org, teamSlug, username, }: {
-        org: string;
-        teamSlug: string;
-        username: string;
-    }): Promise<boolean>;
-}

package/dist/gh/team/index.js

@@ -1,31 +0,0 @@
-export class GitHubTeamManager {
-    client;
-    constructor(client) {
-        this.client = client;
-    }
-    /**
-     * Confirms whether the given user is an active member of a team within an org.
-     *
-     * @note this only returns `true` for `active` memberships. A user with a `pending`
-     * invite (has not accepted yet) will return `false`.
-     */
-    async isTeamMember({ org, teamSlug, username, }) {
-        try {
-            const { data } = await this.client.rest.teams.getMembershipForUserInOrg({
-                org,
-                team_slug: teamSlug,
-                username,
-            });
-            return data.state === "active";
-        }
-        catch (e) {
-            if (e &&
-                typeof e === "object" &&
-                "status" in e &&
-                e.status === 404) {
-                return false;
-            }
-            throw e;
-        }
-    }
-}