@tahminator/pipeline 1.0.4 → 1.0.6

package/dist/docker/index.d.ts

@@ -1,7 +1,21 @@
 export declare class DockerClient {
     private readonly username;
-    private readonly pat;
     private constructor();
+    /**
+     * @note This class must be cleaned up manually by calling `cleanup()`.
+     * You can also do this manually by utilizing the [`usage`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html#using-declarations-and-explicit-resource-management) keyword.
+     *
+     * @example
+     * ```ts
+     * export async function main() {
+     *    await using client = await DockerClient.create(username, pat);
+     *
+     *    client.promoteDockerImage({});
+     *
+     *    // client will automatically be cleaned up at the end of the scope.
+     * }
+     * ```
+     */
     static create(username: string, pat: string): Promise<DockerClient>;
     /**
      * Will lookup the Docker Hub image of `originalTag` & add `newGithubTags` to it.
@@ -11,5 +25,18 @@ export declare class DockerClient {
         newGithubTags: string[];
         repository: string;
     }): Promise<void>;
+    buildImage(args: {
+        dockerFileLocation: string;
+        /**
+         * @example ["staging-latest", `staging-${sha}`, `staging-%{timestamp.toString()}`]
+         */
+        tags: string[];
+        dockerUsername: string;
+        dockerRepository: string;
+        shouldUpload?: boolean;
+        platforms?: string[];
+        buildArgs?: Record<string, string | number | boolean>;
+    }): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
     cleanup(): Promise<void>;
 }

package/dist/docker/index.js

@@ -1,13 +1,27 @@
 import { $ } from "bun";
+import { cyan } from "../utils/colors";
 export class DockerClient {
     username;
-    pat;
-    constructor(username, pat) {
+    constructor(username) {
         this.username = username;
-        this.pat = pat;
     }
+    /**
+     * @note This class must be cleaned up manually by calling `cleanup()`.
+     * You can also do this manually by utilizing the [`usage`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-2.html#using-declarations-and-explicit-resource-management) keyword.
+     *
+     * @example
+     * ```ts
+     * export async function main() {
+     *    await using client = await DockerClient.create(username, pat);
+     *
+     *    client.promoteDockerImage({});
+     *
+     *    // client will automatically be cleaned up at the end of the scope.
+     * }
+     * ```
+     */
     static async create(username, pat) {
-        const client = new DockerClient(username, pat);
+        const client = new DockerClient(username);
         await $ `echo ${pat} | docker login -u ${username} --password-stdin`;
         return client;
     }
@@ -26,6 +40,43 @@ export class DockerClient {
         }
         console.log(`Promoted ${originalTag} to: ${newGithubTags.join(", ")}`);
     }
+    async buildImage(args) {
+        const { dockerFileLocation, tags, dockerUsername, dockerRepository, shouldUpload = true, platforms = ["linux/amd64"], buildArgs = {}, } = args;
+        if (!tags.length) {
+            throw new Error("You must provide atleast one tag.");
+        }
+        console.log("Building image with following tags:");
+        tags.forEach((tag) => console.log(cyan(tag)));
+        try {
+            await $ `docker buildx create --use --name ${dockerRepository}-builder`;
+        }
+        catch {
+            await $ `docker buildx use ${dockerRepository}-builder`;
+        }
+        const buildModeFlag = shouldUpload ? "--push" : "--load";
+        const tagFlags = tags.flatMap((tag) => [
+            "--tag",
+            `${dockerUsername}/${dockerRepository}:${tag}`,
+        ]);
+        const buildArgFlags = Object.entries(buildArgs).flatMap(([k, v]) => [
+            "--build-arg",
+            `${k}=${v.toString()}`,
+        ]);
+        await $ `docker buildx build ${buildModeFlag} \
+              --platform ${platforms.join(",")} \
+              --file ${dockerFileLocation} \
+              --cache-from=type=gha \
+              --cache-to=type=gha,mode=max \
+              ${buildArgFlags} \
+              ${tagFlags} \
+              .`;
+        console.log(shouldUpload ?
+            `Image build & successfully uploaded to ${dockerUsername}/${dockerRepository}`
+            : "Image has been built (upload skipped.)");
+    }
+    async [Symbol.asyncDispose]() {
+        await this.cleanup();
+    }
     async cleanup() {
         await $ `docker logout`;
     }

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

@@ -3,9 +3,10 @@ import semver from "semver";
 import type { OwnerString, RepoString } from "../../types";
 export declare class GitHubTagManager {
     private readonly client;
-    readonly isExplicitToken: boolean;
+    private readonly isExplicitToken;
     private static readonly BASE_VERSION;
     constructor(client: Octokit, isExplicitToken: boolean);
+    private checkToken;
     /**
      * Utilizes the GitHub API to create a new tag version in the given repository.
      *

package/dist/gh/tag/index.js

@@ -8,7 +8,9 @@ export class GitHubTagManager {
     constructor(client, isExplicitToken) {
         this.client = client;
         this.isExplicitToken = isExplicitToken;
-        if (!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");
         }
     }
@@ -20,6 +22,7 @@ export class GitHubTagManager {
      * a GitHub PAT.
      */
     async createTag({ repositoryOverride, releaseType, onPreTagCreate, }) {
+        this.checkToken();
         const repositoryEnv = (() => {
             const v = process.env.GITHUB_REPOSITORY;
             return v;

package/dist/utils/colors.d.ts

@@ -0,0 +1,22 @@
+export declare function black(s: string): string;
+export declare function red(s: string): string;
+export declare function green(s: string): string;
+export declare function yellow(s: string): string;
+export declare function blue(s: string): string;
+export declare function magenta(s: string): string;
+export declare function cyan(s: string): string;
+export declare function white(s: string): string;
+export declare function gray(s: string): string;
+export declare function brightRed(s: string): string;
+export declare function brightGreen(s: string): string;
+export declare function brightYellow(s: string): string;
+export declare function brightBlue(s: string): string;
+export declare function brightMagenta(s: string): string;
+export declare function brightCyan(s: string): string;
+export declare function brightWhite(s: string): string;
+export declare function pink(s: string): string;
+export declare function orange(s: string): string;
+export declare function bold(s: string): string;
+export declare function dim(s: string): string;
+export declare function italic(s: string): string;
+export declare function underline(s: string): string;

package/dist/utils/colors.js

@@ -0,0 +1,89 @@
+export function black(s) {
+    return `${BLACK}${s}${RESET}`;
+}
+export function red(s) {
+    return `${RED}${s}${RESET}`;
+}
+export function green(s) {
+    return `${GREEN}${s}${RESET}`;
+}
+export function yellow(s) {
+    return `${YELLOW}${s}${RESET}`;
+}
+export function blue(s) {
+    return `${BLUE}${s}${RESET}`;
+}
+export function magenta(s) {
+    return `${MAGENTA}${s}${RESET}`;
+}
+export function cyan(s) {
+    return `${CYAN}${s}${RESET}`;
+}
+export function white(s) {
+    return `${WHITE}${s}${RESET}`;
+}
+export function gray(s) {
+    return `${GRAY}${s}${RESET}`;
+}
+export function brightRed(s) {
+    return `${BRIGHT_RED}${s}${RESET}`;
+}
+export function brightGreen(s) {
+    return `${BRIGHT_GREEN}${s}${RESET}`;
+}
+export function brightYellow(s) {
+    return `${BRIGHT_YELLOW}${s}${RESET}`;
+}
+export function brightBlue(s) {
+    return `${BRIGHT_BLUE}${s}${RESET}`;
+}
+export function brightMagenta(s) {
+    return `${BRIGHT_MAGENTA}${s}${RESET}`;
+}
+export function brightCyan(s) {
+    return `${BRIGHT_CYAN}${s}${RESET}`;
+}
+export function brightWhite(s) {
+    return `${BRIGHT_WHITE}${s}${RESET}`;
+}
+export function pink(s) {
+    return `${PINK}${s}${RESET}`;
+}
+export function orange(s) {
+    return `${ORANGE}${s}${RESET}`;
+}
+export function bold(s) {
+    return `${BOLD}${s}${RESET}`;
+}
+export function dim(s) {
+    return `${DIM}${s}${RESET}`;
+}
+export function italic(s) {
+    return `${ITALIC}${s}${RESET}`;
+}
+export function underline(s) {
+    return `${UNDERLINE}${s}${RESET}`;
+}
+const BLACK = "\x1b[30m";
+const RED = "\x1b[31m";
+const GREEN = "\x1b[32m";
+const YELLOW = "\x1b[33m";
+const BLUE = "\x1b[34m";
+const MAGENTA = "\x1b[35m";
+const CYAN = "\x1b[36m";
+const WHITE = "\x1b[37m";
+const GRAY = "\x1b[90m";
+const BRIGHT_RED = "\x1b[91m";
+const BRIGHT_GREEN = "\x1b[92m";
+const BRIGHT_YELLOW = "\x1b[93m";
+const BRIGHT_BLUE = "\x1b[94m";
+const BRIGHT_MAGENTA = "\x1b[95m";
+const BRIGHT_CYAN = "\x1b[96m";
+const BRIGHT_WHITE = "\x1b[97m";
+const PINK = "\x1b[38;5;213m";
+const ORANGE = "\x1b[38;5;214m";
+const RESET = "\x1b[0m";
+const BOLD = "\x1b[1m";
+const DIM = "\x1b[2m";
+const ITALIC = "\x1b[3m";
+const UNDERLINE = "\x1b[4m";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tahminator/pipeline",
   "type": "module",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",