@tahminator/pipeline 1.0.55 → 1.0.56-beta.f14b8709

package/dist/index.d.ts

@@ -6,3 +6,4 @@ export * from "./pulumi";
 export * from "./types";
 export * from "./env";
 export * from "./utils";
+export * from "./versioning";

package/dist/index.js

@@ -6,3 +6,4 @@ export * from "./pulumi";
 export * from "./types";
 export * from "./env";
 export * from "./utils";
+export * from "./versioning";

package/dist/internal/upload-npm/beta/index.js

@@ -4,6 +4,8 @@ import { EnvClient, EnvClientStrategy } from "../../../env";
 import { GitHubClient } from "../../../gh";
 import { NPMClient } from "../../../npm";
 import { Utils } from "../../../utils";
+import { VersioningClient } from "../../../versioning";
+import { VersionUpdatingStrategy } from "../../../versioning/types";
 const { sha, prId } = await yargs(hideBin(process.argv))
     .option("sha", {
     type: "string",
@@ -24,13 +26,14 @@ async function main() {
         privateKey: await Utils.decodeBase64EncodedString(githubAppPrivateKeyB64),
     });
     const npmClient = await NPMClient.create();
+    const versioningClient = new VersioningClient(ghClient, VersionUpdatingStrategy.JSTS);
     const shortSha = await getShortSha(sha);
     const lastTag = (await ghClient.getLatestTag()) ?? GitHubClient.BASE_VERSION;
     const betaVersion = `${lastTag}-beta.${shortSha}`;
     if (!Utils.SemVer.validate(betaVersion)) {
         throw new Error(`Generated invalid beta version: ${betaVersion}`);
     }
-    await Utils.updateAllPackageJsonsWithVersion(betaVersion);
+    await versioningClient.update(betaVersion);
     await npmClient.publish(false, true);
     console.log(`Uploaded ${betaVersion} to NPM.`);
     await ghClient.sendPrMessage({

package/dist/utils/client.d.ts

@@ -9,7 +9,6 @@ export declare class Utils {
     static Log: typeof Log;
     static SemVer: typeof SemVer;
     static generateShortId(...args: Parameters<typeof generateShortId>): string;
-    static updateAllPackageJsonsWithVersion(version: string): Promise<void>;
     static isCmdAvailable(...args: Parameters<typeof isCmdAvailable>): Promise<boolean>;
     static decodeBase64EncodedString(...args: Parameters<typeof decodeBase64EncodedString>): Promise<string>;
 }

package/dist/utils/client.js

@@ -1,4 +1,3 @@
-import { $ } from "bun";
 import { decodeBase64EncodedString } from "./b64";
 import { isCmdAvailable } from "./cmd";
 import { Colors } from "./colors";
@@ -13,18 +12,6 @@ export class Utils {
     static generateShortId(...args) {
         return generateShortId(...args);
     }
-    static async updateAllPackageJsonsWithVersion(version) {
-        const files = (await $ `find . -name "package.json" -not -path "*/node_modules/*"`.text())
-            .trim()
-            .split("\n");
-        for (const fileLocation of files) {
-            const file = Bun.file(fileLocation);
-            const pkg = await file.json();
-            pkg.version = version;
-            await Bun.write(fileLocation, JSON.stringify(pkg, null, 2) + "\n");
-            console.log(`Successfully updated version in ${fileLocation} to ${version}`);
-        }
-    }
     static async isCmdAvailable(...args) {
         return isCmdAvailable(...args);
     }

package/dist/versioning/client.d.ts

@@ -0,0 +1,26 @@
+import type { GitHubClient } from "../gh";
+import { VersionUpdatingStrategy, type IVersioningClient } from "./types";
+export declare class VersioningClient implements IVersioningClient {
+    private readonly githubClient;
+    private static readonly INITIAL_VERSION;
+    private readonly delegate;
+    constructor(githubClient: GitHubClient, strategy: VersionUpdatingStrategy);
+    private getDelegate;
+    private parseOrThrow;
+    update(version: string): Promise<void>;
+    /**
+     * generate next version tag.
+     *
+     * If `baseVersion` is not passed in:
+     * - if the repository has no tags yet, it will return `1.0.0`
+     * - otherwise, it will bump the latest tag's patch number
+     *
+     * if `baseVersion` is passed in, it will consult the github client and do the following:
+     *
+     * - if the github client reports a latest tag with the same `MAJOR` and `MINOR` version as `baseVersion`, it will just bump `PATCH` number
+     * - if the github client reports a latest tag with a lower `MAJOR` and `MINOR` version than `baseVersion`, it will match `baseVersion`'s `MAJOR` & `MINOR`. __It will NOT bump `PATCH` number.__
+     *
+     * `baseVersion` must set patch number to `0`. (e.g. `1.0.0`, `1.5.0`, `2.0.0`, etc.)
+     */
+    next(baseVersion?: string, ...opts: Parameters<GitHubClient["getLatestTag"]>): Promise<string>;
+}

package/dist/versioning/client.js

@@ -0,0 +1,70 @@
+import semver from "semver";
+import { VersionUpdatingStrategy, } from "./types";
+import { JavaMavenVersioningClient } from "./updating/java/maven";
+import { JavascriptPackageJsonVersioningClient } from "./updating/jsts";
+export class VersioningClient {
+    githubClient;
+    static INITIAL_VERSION = "1.0.0";
+    delegate;
+    constructor(githubClient, strategy) {
+        this.githubClient = githubClient;
+        this.delegate = this.getDelegate(strategy);
+    }
+    getDelegate(strategy) {
+        switch (strategy) {
+            case VersionUpdatingStrategy.JSTS:
+                return new JavascriptPackageJsonVersioningClient();
+            case VersionUpdatingStrategy.JAVA_MAVEN:
+                return new JavaMavenVersioningClient();
+        }
+    }
+    parseOrThrow(label, v) {
+        const s = semver.parse(v);
+        if (!s) {
+            throw new Error(`${label} is not valid semver`);
+        }
+        return s;
+    }
+    async update(version) {
+        await this.delegate.update(version);
+    }
+    /**
+     * generate next version tag.
+     *
+     * If `baseVersion` is not passed in:
+     * - if the repository has no tags yet, it will return `1.0.0`
+     * - otherwise, it will bump the latest tag's patch number
+     *
+     * if `baseVersion` is passed in, it will consult the github client and do the following:
+     *
+     * - if the github client reports a latest tag with the same `MAJOR` and `MINOR` version as `baseVersion`, it will just bump `PATCH` number
+     * - if the github client reports a latest tag with a lower `MAJOR` and `MINOR` version than `baseVersion`, it will match `baseVersion`'s `MAJOR` & `MINOR`. __It will NOT bump `PATCH` number.__
+     *
+     * `baseVersion` must set patch number to `0`. (e.g. `1.0.0`, `1.5.0`, `2.0.0`, etc.)
+     */
+    async next(baseVersion, ...opts) {
+        const latestTag = await this.githubClient.getLatestTag(...opts);
+        if (!baseVersion) {
+            if (!latestTag) {
+                return VersioningClient.INITIAL_VERSION;
+            }
+            else {
+                const latestSemver = this.parseOrThrow("latest tag from github", latestTag);
+                return latestSemver.inc("patch").toString();
+            }
+        }
+        const baseVersionSemver = this.parseOrThrow("baseVersion", baseVersion);
+        if (baseVersionSemver.patch !== 0) {
+            throw new Error("baseVersion has a non-zero patch number.");
+        }
+        if (!latestTag) {
+            return baseVersionSemver.inc("patch").toString();
+        }
+        const latestSemver = this.parseOrThrow("latest tag from github", latestTag);
+        if (latestSemver.major === baseVersionSemver.major &&
+            latestSemver.minor === baseVersionSemver.minor) {
+            return latestSemver.inc("patch").toString();
+        }
+        return baseVersionSemver.toString();
+    }
+}

package/dist/versioning/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * from "./types";

package/dist/versioning/index.js

@@ -0,0 +1,2 @@
+export * from "./client";
+export * from "./types";

package/dist/versioning/types.d.ts

@@ -0,0 +1,28 @@
+export declare enum VersionUpdatingStrategy {
+    JSTS = 0,
+    JAVA_MAVEN = 1
+}
+export interface IVersionUpdatingClient {
+    update(version: string): Promise<void>;
+}
+export interface IVersioningClient extends IVersionUpdatingClient {
+    /**
+     * generate next version tag.
+     *
+     * If `baseVersion` is not passed in:
+     * - if the repository has no tags yet, it will return `1.0.0`
+     * - otherwise, it will bump the latest tag's patch number
+     *
+     * if `baseVersion` is passed in, it will consult the github client and do the following:
+     *
+     * - if the github client reports a latest tag with the same `MAJOR` and `MINOR` version as `baseVersion`, it will just bump `PATCH` number
+     * - if the github client reports a latest tag with a lower `MAJOR` and `MINOR` version than `baseVersion`, it will match `baseVersion`'s `MAJOR` & `MINOR`. __It will NOT bump `PATCH` number.__
+     *
+     * `baseVersion` must set patch number to `0`. (e.g. `1.0.0`, `1.5.0`, `2.0.0`, etc.)
+     */
+    next(baseVersion?: string): Promise<string>;
+}
+export interface IJavascriptPackageJsonVersionUpdatingClient extends IVersionUpdatingClient {
+}
+export interface IJavaMavenVersionUpdatingClient extends IVersionUpdatingClient {
+}

package/dist/versioning/types.js

@@ -0,0 +1,5 @@
+export var VersionUpdatingStrategy;
+(function (VersionUpdatingStrategy) {
+    VersionUpdatingStrategy[VersionUpdatingStrategy["JSTS"] = 0] = "JSTS";
+    VersionUpdatingStrategy[VersionUpdatingStrategy["JAVA_MAVEN"] = 1] = "JAVA_MAVEN";
+})(VersionUpdatingStrategy || (VersionUpdatingStrategy = {}));

package/dist/versioning/updating/base.d.ts

@@ -0,0 +1,6 @@
+import type { IVersionUpdatingClient } from "../types";
+export declare abstract class BaseVersionUpdatingClient implements IVersionUpdatingClient {
+    abstract update(version: string): Promise<void>;
+    protected logFileLocationUpdated(fileLocation: string, version: string): void;
+    protected findFiles(filePattern: string, pathExclusionRegex?: RegExp): Promise<string[]>;
+}

package/dist/versioning/updating/base.js

@@ -0,0 +1,16 @@
+export class BaseVersionUpdatingClient {
+    logFileLocationUpdated(fileLocation, version) {
+        console.log(`Successfully updated version in ${fileLocation} to ${version}`);
+    }
+    async findFiles(filePattern, pathExclusionRegex) {
+        const glob = new Bun.Glob(filePattern);
+        const files = [];
+        for await (const file of glob.scan(".")) {
+            if (pathExclusionRegex && pathExclusionRegex.test(file)) {
+                continue;
+            }
+            files.push(file);
+        }
+        return files;
+    }
+}

package/dist/versioning/updating/java/maven/index.d.ts

@@ -0,0 +1,6 @@
+import type { IJavaMavenVersionUpdatingClient } from "../../../types";
+import { BaseVersionUpdatingClient } from "../../base";
+export declare class JavaMavenVersioningClient extends BaseVersionUpdatingClient implements IJavaMavenVersionUpdatingClient {
+    private getVersionNode;
+    update(version: string): Promise<void>;
+}

package/dist/versioning/updating/java/maven/index.js

@@ -0,0 +1,28 @@
+import { XmlElement, XmlParser, XmlText } from "xml-trueformat";
+import { BaseVersionUpdatingClient } from "../../base";
+export class JavaMavenVersioningClient extends BaseVersionUpdatingClient {
+    getVersionNode(projectNode) {
+        const versionNode = projectNode.children.find((child) => child instanceof XmlElement && child.tagName === "version");
+        if (!versionNode) {
+            throw new Error("Can't find version tag inside of project tag in pom.xml");
+        }
+        return versionNode;
+    }
+    async update(version) {
+        const files = await this.findFiles("pom.xml");
+        for (const fileLocation of files) {
+            const file = Bun.file(fileLocation);
+            const oldPomStr = await file.text();
+            const pom = XmlParser.parse(oldPomStr);
+            const projectNode = pom.getRootElement();
+            if (projectNode.tagName !== "project") {
+                throw new Error("Can't find project tag inside of pom.xml");
+            }
+            const versionNode = this.getVersionNode(projectNode);
+            versionNode.children = [new XmlText(version)];
+            const newPomStr = pom.toString();
+            await Bun.write(fileLocation, newPomStr);
+            this.logFileLocationUpdated(fileLocation, version);
+        }
+    }
+}

package/dist/versioning/updating/jsts/index.d.ts

@@ -0,0 +1,5 @@
+import type { IJavascriptPackageJsonVersionUpdatingClient } from "../../types";
+import { BaseVersionUpdatingClient } from "../base";
+export declare class JavascriptPackageJsonVersioningClient extends BaseVersionUpdatingClient implements IJavascriptPackageJsonVersionUpdatingClient {
+    update(version: string): Promise<void>;
+}

package/dist/versioning/updating/jsts/index.js

@@ -0,0 +1,13 @@
+import { BaseVersionUpdatingClient } from "../base";
+export class JavascriptPackageJsonVersioningClient extends BaseVersionUpdatingClient {
+    async update(version) {
+        const files = await this.findFiles("**/package.json", /(^|\/)node_modules\//);
+        for (const fileLocation of files) {
+            const file = Bun.file(fileLocation);
+            const pkg = await file.json();
+            pkg.version = version;
+            await Bun.write(fileLocation, JSON.stringify(pkg, null, 2) + "\n");
+            this.logFileLocationUpdated(fileLocation, version);
+        }
+    }
+}

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.55",
+  "version": "1.0.56-beta.f14b8709",
   "repository": {
     "url": "git+https://github.com/tahminator/pipeline.git"
   },
@@ -52,8 +52,11 @@
     "@octokit/rest": "^22.0.1",
     "@pulumi/pulumi": "^3.230.0",
     "ansi-to-html": "^0.7.2",
+    "fast-xml-builder": "^1.1.5",
+    "fast-xml-parser": "^5.7.2",
     "neverthrow": "^8.2.0",
     "semver": "^7.7.4",
+    "xml-trueformat": "^0.9.5",
     "yaml": "^2.8.2",
     "yargs": "^18.0.0",
     "zod": "^4.3.6"