@tahminator/pipeline 1.0.56 → 1.0.58

package/dist/gh/client.d.ts

@@ -4,7 +4,6 @@ import { GitHubTagManager } from "./tag";
 export declare class GitHubClient {
     private readonly client;
     private readonly isExplicitToken;
-    static readonly BASE_VERSION = "1.0.0";
     private readonly tagManager;
     private readonly outputManager;
     private readonly prManager;

package/dist/gh/client.js

@@ -6,7 +6,6 @@ import { GitHubTagManager } from "./tag";
 export class GitHubClient {
     client;
     isExplicitToken;
-    static BASE_VERSION = GitHubTagManager.BASE_VERSION;
     tagManager;
     outputManager;
     prManager;

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

@@ -1,10 +1,8 @@
 import { Octokit } from "@octokit/rest";
-import semver from "semver";
 import type { OwnerString, RepoString } from "../../types";
 export declare class GitHubTagManager {
     private readonly client;
     private readonly isExplicitToken;
-    static readonly BASE_VERSION = "1.0.0";
     constructor(client: Octokit, isExplicitToken: boolean);
     private checkToken;
     /**
@@ -19,10 +17,12 @@ export declare class GitHubTagManager {
      * @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({ repositoryOverride, releaseType, onPreTagCreate, }: {
+    createTag({ nextTag, repositoryOverride, onPreTagCreate, }: {
+        nextTag: string;
         repositoryOverride?: [OwnerString, RepoString];
-        releaseType?: semver.ReleaseType;
         onPreTagCreate?: (tag: string) => Promise<void>;
     }): Promise<void>;
     private parseRepository;

package/dist/gh/tag/index.js

@@ -4,7 +4,6 @@ import semver from "semver";
 export class GitHubTagManager {
     client;
     isExplicitToken;
-    static BASE_VERSION = "1.0.0";
     constructor(client, isExplicitToken) {
         this.client = client;
         this.isExplicitToken = isExplicitToken;
@@ -37,19 +36,12 @@ export class GitHubTagManager {
      * @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({ repositoryOverride, releaseType, onPreTagCreate, }) {
+    async createTag({ nextTag, repositoryOverride, onPreTagCreate, }) {
         this.checkToken();
         const [owner, repo] = this.parseRepository(repositoryOverride);
-        const lastTag = await this.getLatestTag({
-            repositoryOverride: [owner, repo],
-        });
-        const nextTag = lastTag ?
-            semver.inc(lastTag, releaseType ?? "patch")
-            : GitHubTagManager.BASE_VERSION;
-        if (!nextTag) {
-            throw new Error("Could not increment version");
-        }
         const { data: repository } = await this.client.rest.repos.get({
             owner,
             repo,

package/dist/internal/create-tag/index.js

@@ -1,6 +1,7 @@
 import { EnvClient, EnvClientStrategy } from "../../env";
 import { GitHubClient } from "../../gh";
 import { Utils } from "../../utils";
+import { VersioningClient, VersionUpdatingStrategy } from "../../versioning";
 async function main() {
     const envClient = EnvClient.create(EnvClientStrategy.GIT_CRYPT);
     const { githubAppAppId, githubAppInstallationId, githubAppPrivateKeyB64 } = parseCiEnv(await envClient.readFromEnv(".env.ci"));
@@ -9,7 +10,10 @@ async function main() {
         installationId: githubAppInstallationId,
         privateKey: await Utils.decodeBase64EncodedString(githubAppPrivateKeyB64),
     });
+    const versioningClient = new VersioningClient(ghClient, VersionUpdatingStrategy.JSTS);
+    const rootPkgJson = await Bun.file("./package.json").json();
     await ghClient.createTag({
+        nextTag: await versioningClient.next(rootPkgJson.version),
         onPreTagCreate: async (tag) => {
             const file = Bun.file("./package.json");
             const pkg = await file.json();

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

@@ -5,7 +5,7 @@ import { GitHubClient } from "../../../gh";
 import { NPMClient } from "../../../npm";
 import { Utils } from "../../../utils";
 import { VersioningClient } from "../../../versioning";
-import { VersioningStrategy } from "../../../versioning/types";
+import { VersionUpdatingStrategy } from "../../../versioning/types";
 const { sha, prId } = await yargs(hideBin(process.argv))
     .option("sha", {
     type: "string",
@@ -26,10 +26,9 @@ async function main() {
         privateKey: await Utils.decodeBase64EncodedString(githubAppPrivateKeyB64),
     });
     const npmClient = await NPMClient.create();
-    const versioningClient = new VersioningClient(VersioningStrategy.JSTS);
+    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}`;
+    const betaVersion = await versioningClient.nextBeta(shortSha);
     if (!Utils.SemVer.validate(betaVersion)) {
         throw new Error(`Generated invalid beta version: ${betaVersion}`);
     }

package/dist/versioning/client.d.ts

@@ -1,7 +1,34 @@
-import { VersioningStrategy, type IVersioningClient } from "./types";
+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(strategy: VersioningStrategy);
+    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>;
+    /**
+     * generate next beta version tag using a `sha`.
+     *
+     * simply finds latest version from github and generates `{version}-beta.{sha}` to it.
+     *
+     * for example, `1.3.2-beta.58cf28bd`
+     */
+    nextBeta(sha: string, ...opts: Parameters<GitHubClient["getLatestTag"]>): Promise<string>;
 }

package/dist/versioning/client.js

@@ -1,20 +1,85 @@
-import { JavaMavenVersioningClient } from "./java/maven";
-import { JavascriptPackageJsonVersioningClient } from "./jsts";
-import { VersioningStrategy } from "./types";
+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(strategy) {
+    constructor(githubClient, strategy) {
+        this.githubClient = githubClient;
         this.delegate = this.getDelegate(strategy);
     }
     getDelegate(strategy) {
         switch (strategy) {
-            case VersioningStrategy.JSTS:
+            case VersionUpdatingStrategy.JSTS:
                 return new JavascriptPackageJsonVersioningClient();
-            case VersioningStrategy.JAVA_MAVEN:
+            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();
+    }
+    /**
+     * generate next beta version tag using a `sha`.
+     *
+     * simply finds latest version from github and generates `{version}-beta.{sha}` to it.
+     *
+     * for example, `1.3.2-beta.58cf28bd`
+     */
+    async nextBeta(sha, ...opts) {
+        const latestTag = await this.githubClient.getLatestTag(...opts);
+        if (!latestTag) {
+            throw new Error("You must upload a tag atleast once before generating a beta tag.");
+        }
+        const latest = this.parseOrThrow("latest tag from github", latestTag);
+        return `${latest.toString()}-beta.${sha}`;
+    }
 }

package/dist/versioning/types.d.ts

@@ -1,11 +1,38 @@
-export declare enum VersioningStrategy {
+export declare enum VersionUpdatingStrategy {
     JSTS = 0,
     JAVA_MAVEN = 1
 }
-export interface IVersioningClient {
+export interface IVersionUpdatingClient {
     update(version: string): Promise<void>;
 }
-export interface IJavascriptPackageJsonVersioningClient extends IVersioningClient {
+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>;
+    /**
+     * generate next beta version tag.
+     *
+     * simply finds latest version from github and generates `{version}-beta.{sha}` to it.
+     *
+     * @note you may pass in the first 8 characters of `sha` if you choose.
+     *
+     * for example, `1.3.2-beta.58cf28bd`
+     */
+    nextBeta(sha: string): Promise<string>;
 }
-export interface IJavaMavenVersioningClient extends IVersioningClient {
+export interface IJavascriptPackageJsonVersionUpdatingClient extends IVersionUpdatingClient {
+}
+export interface IJavaMavenVersionUpdatingClient extends IVersionUpdatingClient {
 }

package/dist/versioning/types.js

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

package/dist/versioning/{base.d.ts → updating/base.d.ts}

@@ -1,5 +1,5 @@
-import type { IVersioningClient } from "./types";
-export declare abstract class BaseVersioningClient implements IVersioningClient {
+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/{base.js → updating/base.js}

@@ -1,4 +1,4 @@
-export class BaseVersioningClient {
+export class BaseVersionUpdatingClient {
     logFileLocationUpdated(fileLocation, version) {
         console.log(`Successfully updated version in ${fileLocation} to ${version}`);
     }

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/{java → updating/java}/maven/index.js

@@ -1,6 +1,6 @@
 import { XmlElement, XmlParser, XmlText } from "xml-trueformat";
-import { BaseVersioningClient } from "../../base";
-export class JavaMavenVersioningClient extends BaseVersioningClient {
+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) {

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/{jsts → updating/jsts}/index.js

@@ -1,5 +1,5 @@
-import { BaseVersioningClient } from "../base";
-export class JavascriptPackageJsonVersioningClient extends BaseVersioningClient {
+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) {

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

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

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

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

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