@tahminator/pipeline 1.0.74 → 1.0.75

package/dist/gh/client.d.ts

@@ -36,11 +36,93 @@ export declare class GitHubClient {
      * @deprecated use `createWithGithubAppToken`
      */
     static createWithPatCiToken(pat: string): Promise<GitHubClient>;
+    /**
+     * Utilizes the GitHub API to create a new tag version in the given repository.
+     *
+     * @note You **must** pass in a GitHub token because the regular Github bot token
+     * cannot trigger actions (due to fear of recursion). You must either provide a GitHub App token or
+     * a GitHub PAT.
+     *
+     * @note you should use `VersioningClient` to generate `nextTag`
+     */
     createTag(...args: Parameters<GitHubTagManager["createTag"]>): Promise<void>;
+    /**
+     * Returns the latest stable semver tag in the repository.
+     */
     getLatestTag(...args: Parameters<GitHubTagManager["getLatestTag"]>): Promise<string | null>;
+    /**
+     * Write an output back to Github Actions in order to re-use / pass
+     * data between steps, jobs, etc.
+     *
+     * @see documentation for passing outputs between jobs [here](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs)
+     */
     outputToGithubOutput(...args: Parameters<GitHubOutputManager["outputToGithubOutput"]>): Promise<void>;
+    /**
+     *
+     * update k8s manifest repo with new tag version.
+     *
+     * @note `kustomizationFile` must look like this:
+     *
+     * ```yaml
+     * apiVersion: kustomize.config.k8s.io/v1beta1
+     * kind: Kustomization
+     * resources:
+     *   - deployment.yaml
+     *   - secrets.yaml
+     *   - service.yaml
+     *   - monitor.yaml
+     * commonLabels:
+     *   app: instalock-web
+     *   environment: production
+     * # This part specifically
+     * images:
+     *   - name: tahminator/instalock-web
+     *     newTag: a70ee0e
+     * ```
+     */
     updateK8sTagWithPR(...args: Parameters<GitHubPRManager["updateK8sTagWithPR"]>): Promise<void>;
     sendPrMessage(...args: Parameters<GitHubPRManager["sendPrMessage"]>): 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(...args: Parameters<GitHubPRManager["mergePr"]>): Promise<void>;
+    /**
+     * Create or update a check run (the "status checks" shown on a PR/commit), dispatched by
+     * `action`.
+     */
+    writeStatusCheck(...args: Parameters<GitHubPRManager["writeStatusCheck"]>): Promise<{
+        id: number;
+        head_sha: string;
+        node_id: string;
+        external_id: string | null;
+        url: string;
+        html_url: string | null;
+        details_url: string | null;
+        status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
+        conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
+        started_at: string | null;
+        completed_at: string | null;
+        output: {
+            title: string | null;
+            summary: string | null;
+            text: string | null;
+            annotations_count: number;
+            annotations_url: string;
+        };
+        name: string;
+        check_suite: {
+            id: number;
+        } | null;
+        app: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
+        pull_requests: import("@octokit/openapi-types").components["schemas"]["pull-request-minimal"][];
+        deployment?: import("@octokit/openapi-types").components["schemas"]["deployment-simple"];
+    }>;
+    /**
+     * 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(...args: Parameters<GitHubTeamManager["isTeamMember"]>): Promise<boolean>;
 }

package/dist/gh/client.js

@@ -56,24 +56,82 @@ export class GitHubClient {
             auth: pat,
         }), true);
     }
+    /**
+     * Utilizes the GitHub API to create a new tag version in the given repository.
+     *
+     * @note You **must** pass in a GitHub token because the regular Github bot token
+     * cannot trigger actions (due to fear of recursion). You must either provide a GitHub App token or
+     * a GitHub PAT.
+     *
+     * @note you should use `VersioningClient` to generate `nextTag`
+     */
     createTag(...args) {
         return this.tagManager.createTag(...args);
     }
+    /**
+     * Returns the latest stable semver tag in the repository.
+     */
     getLatestTag(...args) {
         return this.tagManager.getLatestTag(...args);
     }
+    /**
+     * Write an output back to Github Actions in order to re-use / pass
+     * data between steps, jobs, etc.
+     *
+     * @see documentation for passing outputs between jobs [here](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs)
+     */
     outputToGithubOutput(...args) {
         return this.outputManager.outputToGithubOutput(...args);
     }
+    /**
+     *
+     * update k8s manifest repo with new tag version.
+     *
+     * @note `kustomizationFile` must look like this:
+     *
+     * ```yaml
+     * apiVersion: kustomize.config.k8s.io/v1beta1
+     * kind: Kustomization
+     * resources:
+     *   - deployment.yaml
+     *   - secrets.yaml
+     *   - service.yaml
+     *   - monitor.yaml
+     * commonLabels:
+     *   app: instalock-web
+     *   environment: production
+     * # This part specifically
+     * images:
+     *   - name: tahminator/instalock-web
+     *     newTag: a70ee0e
+     * ```
+     */
     updateK8sTagWithPR(...args) {
         return this.prManager.updateK8sTagWithPR(...args);
     }
     sendPrMessage(...args) {
         return this.prManager.sendPrMessage(...args);
     }
+    /**
+     * @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(...args) {
         return this.prManager.mergePr(...args);
     }
+    /**
+     * Create or update a check run (the "status checks" shown on a PR/commit), dispatched by
+     * `action`.
+     */
+    writeStatusCheck(...args) {
+        return this.prManager.writeStatusCheck(...args);
+    }
+    /**
+     * 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(...args) {
         return this.teamManager.isTeamMember(...args);
     }

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

@@ -1,11 +1,5 @@
 export declare class GitHubOutputManager {
     constructor();
-    /**
-     * Write an output back to Github Actions in order to re-use / pass
-     * data between steps, jobs, etc.
-     *
-     * @see documentation for passing outputs between jobs [here](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs)
-     */
     outputToGithubOutput({ overrideGithubOutputFile, ctx, }: {
         overrideGithubOutputFile?: string;
         ctx: Record<string, unknown>;

package/dist/gh/output/index.js

@@ -1,11 +1,5 @@
 export class GitHubOutputManager {
     constructor() { }
-    /**
-     * Write an output back to Github Actions in order to re-use / pass
-     * data between steps, jobs, etc.
-     *
-     * @see documentation for passing outputs between jobs [here](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs)
-     */
     async outputToGithubOutput({ overrideGithubOutputFile, ctx, }) {
         const githubOutputEnv = (() => {
             const v = process.env.GITHUB_OUTPUT;

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

@@ -1,31 +1,38 @@
 import type { Octokit } from "@octokit/rest";
 import type { Environment, OwnerString, RepoString } from "../../types";
+type CheckRunStatus = "queued" | "in_progress" | "completed";
+type CheckRunConclusion = "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out";
+type CheckRunOutput = {
+    title: string;
+    summary: string;
+    text?: string;
+};
+type WriteStatusCheckArgs = {
+    action: "create";
+    owner: string;
+    repository: string;
+    /**
+     * commit sha the check run applies to
+     */
+    sha: string;
+    name: string;
+    status?: CheckRunStatus;
+    conclusion?: CheckRunConclusion;
+    output?: CheckRunOutput;
+    detailsUrl?: string;
+} | {
+    action: "update";
+    owner: string;
+    repository: string;
+    checkRunId: number;
+    status?: CheckRunStatus;
+    conclusion?: CheckRunConclusion;
+    output?: CheckRunOutput;
+    detailsUrl?: string;
+};
 export declare class GitHubPRManager {
     private readonly client;
     constructor(client: Octokit);
-    /**
-     *
-     * update k8s manifest repo with new tag version.
-     *
-     * @note `kustomizationFile` must look like this:
-     *
-     * ```yaml
-     * apiVersion: kustomize.config.k8s.io/v1beta1
-     * kind: Kustomization
-     * resources:
-     *   - deployment.yaml
-     *   - secrets.yaml
-     *   - service.yaml
-     *   - monitor.yaml
-     * commonLabels:
-     *   app: instalock-web
-     *   environment: production
-     * # This part specifically
-     * images:
-     *   - name: tahminator/instalock-web
-     *     newTag: a70ee0e
-     * ```
-     */
     updateK8sTagWithPR({ newTag, imageName, kustomizationFilePath, environment, originRepo, manifestRepo, }: {
         newTag: string;
         imageName: string;
@@ -34,16 +41,39 @@ 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, }: {
         prId: number;
         owner: string;
         repository: string;
         mergeMethod?: "merge" | "squash" | "rebase";
     }): Promise<void>;
+    writeStatusCheck(args: WriteStatusCheckArgs): Promise<{
+        id: number;
+        head_sha: string;
+        node_id: string;
+        external_id: string | null;
+        url: string;
+        html_url: string | null;
+        details_url: string | null;
+        status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
+        conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
+        started_at: string | null;
+        completed_at: string | null;
+        output: {
+            title: string | null;
+            summary: string | null;
+            text: string | null;
+            annotations_count: number;
+            annotations_url: string;
+        };
+        name: string;
+        check_suite: {
+            id: number;
+        } | null;
+        app: import("@octokit/openapi-types").components["schemas"]["nullable-integration"];
+        pull_requests: import("@octokit/openapi-types").components["schemas"]["pull-request-minimal"][];
+        deployment?: import("@octokit/openapi-types").components["schemas"]["deployment-simple"];
+    }>;
     sendPrMessage({ prId, owner, repository, message, }: {
         prId: number;
         owner: string;
@@ -51,3 +81,4 @@ export declare class GitHubPRManager {
         message: string;
     }): Promise<void>;
 }
+export {};

package/dist/gh/pr/index.js

@@ -6,29 +6,6 @@ export class GitHubPRManager {
     constructor(client) {
         this.client = client;
     }
-    /**
-     *
-     * update k8s manifest repo with new tag version.
-     *
-     * @note `kustomizationFile` must look like this:
-     *
-     * ```yaml
-     * apiVersion: kustomize.config.k8s.io/v1beta1
-     * kind: Kustomization
-     * resources:
-     *   - deployment.yaml
-     *   - secrets.yaml
-     *   - service.yaml
-     *   - monitor.yaml
-     * commonLabels:
-     *   app: instalock-web
-     *   environment: production
-     * # This part specifically
-     * images:
-     *   - name: tahminator/instalock-web
-     *     newTag: a70ee0e
-     * ```
-     */
     async updateK8sTagWithPR({ newTag, imageName, kustomizationFilePath, environment, originRepo, manifestRepo, }) {
         const [manifestOwner, manifestRepository] = manifestRepo;
         const [originOwner, originRepository] = originRepo;
@@ -97,10 +74,6 @@ export class GitHubPRManager {
             repository: manifestRepository,
         });
     }
-    /**
-     * @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({
             owner,
@@ -109,6 +82,37 @@ export class GitHubPRManager {
             merge_method: mergeMethod,
         });
     }
+    async writeStatusCheck(args) {
+        switch (args.action) {
+            case "create": {
+                const { owner, repository, sha, name, status, conclusion, output, detailsUrl, } = args;
+                const { data } = await this.client.rest.checks.create({
+                    owner,
+                    repo: repository,
+                    head_sha: sha,
+                    name,
+                    status,
+                    conclusion,
+                    output,
+                    details_url: detailsUrl,
+                });
+                return data;
+            }
+            case "update": {
+                const { owner, repository, checkRunId, status, conclusion, output, detailsUrl, } = args;
+                const { data } = await this.client.rest.checks.update({
+                    owner,
+                    repo: repository,
+                    check_run_id: checkRunId,
+                    status,
+                    conclusion,
+                    output,
+                    details_url: detailsUrl,
+                });
+                return data;
+            }
+        }
+    }
     async sendPrMessage({ prId, owner, repository, message, }) {
         await this.client.rest.issues.createComment({
             issue_number: prId,

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

@@ -5,21 +5,9 @@ export declare class GitHubTagManager {
     private readonly isExplicitToken;
     constructor(client: Octokit, isExplicitToken: boolean);
     private checkToken;
-    /**
-     * Returns the latest stable semver tag in the repository.
-     */
     getLatestTag({ repositoryOverride, }?: {
         repositoryOverride?: [OwnerString, RepoString];
     }): Promise<string | null>;
-    /**
-     * Utilizes the GitHub API to create a new tag version in the given repository.
-     *
-     * @note You **must** pass in a GitHub token because the regular Github bot token
-     * cannot trigger actions (due to fear of recursion). You must either provide a GitHub App token or
-     * a GitHub PAT.
-     *
-     * @note you should use `VersioningClient` to generate `nextTag`
-     */
     createTag({ nextTag, repositoryOverride, onPreTagCreate, }: {
         nextTag: string;
         repositoryOverride?: [OwnerString, RepoString];

package/dist/gh/tag/index.js

@@ -13,9 +13,6 @@ export class GitHubTagManager {
             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");
         }
     }
-    /**
-     * Returns the latest stable semver tag in the repository.
-     */
     async getLatestTag({ repositoryOverride, } = {}) {
         const [owner, repo] = this.parseRepository(repositoryOverride);
         const { data: tags } = await this.client.rest.repos.listTags({
@@ -30,15 +27,6 @@ export class GitHubTagManager {
         })
             .sort(semver.rcompare)[0] ?? null);
     }
-    /**
-     * Utilizes the GitHub API to create a new tag version in the given repository.
-     *
-     * @note You **must** pass in a GitHub token because the regular Github bot token
-     * cannot trigger actions (due to fear of recursion). You must either provide a GitHub App token or
-     * a GitHub PAT.
-     *
-     * @note you should use `VersioningClient` to generate `nextTag`
-     */
     async createTag({ nextTag, repositoryOverride, onPreTagCreate, }) {
         this.checkToken();
         const [owner, repo] = this.parseRepository(repositoryOverride);

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

@@ -2,12 +2,6 @@ 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;

package/dist/gh/team/index.js

@@ -3,12 +3,6 @@ export class GitHubTeamManager {
     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({

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.74",
+  "version": "1.0.75",
   "repository": {
     "url": "git+https://github.com/tahminator/pipeline.git"
   },