@tahminator/pipeline 1.0.57 → 1.0.58

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,7 +4,6 @@ import { GitHubTagManager } from "./tag";
4
4
  export declare class GitHubClient {
5
5
  private readonly client;
6
6
  private readonly isExplicitToken;
7
- static readonly BASE_VERSION = "1.0.0";
8
7
  private readonly tagManager;
9
8
  private readonly outputManager;
10
9
  private readonly prManager;
package/dist/gh/client.js CHANGED
@@ -6,7 +6,6 @@ import { GitHubTagManager } from "./tag";
6
6
  export class GitHubClient {
7
7
  client;
8
8
  isExplicitToken;
9
- static BASE_VERSION = GitHubTagManager.BASE_VERSION;
10
9
  tagManager;
11
10
  outputManager;
12
11
  prManager;
@@ -1,10 +1,8 @@
1
1
  import { Octokit } from "@octokit/rest";
2
- import semver from "semver";
3
2
  import type { OwnerString, RepoString } from "../../types";
4
3
  export declare class GitHubTagManager {
5
4
  private readonly client;
6
5
  private readonly isExplicitToken;
7
- static readonly BASE_VERSION = "1.0.0";
8
6
  constructor(client: Octokit, isExplicitToken: boolean);
9
7
  private checkToken;
10
8
  /**
@@ -19,10 +17,12 @@ export declare class GitHubTagManager {
19
17
  * @note You **must** pass in a GitHub token because the regular Github bot token
20
18
  * cannot trigger actions (due to fear of recursion). You must either provide a GitHub App token or
21
19
  * a GitHub PAT.
20
+ *
21
+ * @note you should use `VersioningClient` to generate `nextTag`
22
22
  */
23
- createTag({ repositoryOverride, releaseType, onPreTagCreate, }: {
23
+ createTag({ nextTag, repositoryOverride, onPreTagCreate, }: {
24
+ nextTag: string;
24
25
  repositoryOverride?: [OwnerString, RepoString];
25
- releaseType?: semver.ReleaseType;
26
26
  onPreTagCreate?: (tag: string) => Promise<void>;
27
27
  }): Promise<void>;
28
28
  private parseRepository;
@@ -4,7 +4,6 @@ import semver from "semver";
4
4
  export class GitHubTagManager {
5
5
  client;
6
6
  isExplicitToken;
7
- static BASE_VERSION = "1.0.0";
8
7
  constructor(client, isExplicitToken) {
9
8
  this.client = client;
10
9
  this.isExplicitToken = isExplicitToken;
@@ -37,19 +36,12 @@ export class GitHubTagManager {
37
36
  * @note You **must** pass in a GitHub token because the regular Github bot token
38
37
  * cannot trigger actions (due to fear of recursion). You must either provide a GitHub App token or
39
38
  * a GitHub PAT.
39
+ *
40
+ * @note you should use `VersioningClient` to generate `nextTag`
40
41
  */
41
- async createTag({ repositoryOverride, releaseType, onPreTagCreate, }) {
42
+ async createTag({ nextTag, repositoryOverride, onPreTagCreate, }) {
42
43
  this.checkToken();
43
44
  const [owner, repo] = this.parseRepository(repositoryOverride);
44
- const lastTag = await this.getLatestTag({
45
- repositoryOverride: [owner, repo],
46
- });
47
- const nextTag = lastTag ?
48
- semver.inc(lastTag, releaseType ?? "patch")
49
- : GitHubTagManager.BASE_VERSION;
50
- if (!nextTag) {
51
- throw new Error("Could not increment version");
52
- }
53
45
  const { data: repository } = await this.client.rest.repos.get({
54
46
  owner,
55
47
  repo,
@@ -1,6 +1,7 @@
1
1
  import { EnvClient, EnvClientStrategy } from "../../env";
2
2
  import { GitHubClient } from "../../gh";
3
3
  import { Utils } from "../../utils";
4
+ import { VersioningClient, VersionUpdatingStrategy } from "../../versioning";
4
5
  async function main() {
5
6
  const envClient = EnvClient.create(EnvClientStrategy.GIT_CRYPT);
6
7
  const { githubAppAppId, githubAppInstallationId, githubAppPrivateKeyB64 } = parseCiEnv(await envClient.readFromEnv(".env.ci"));
@@ -9,7 +10,10 @@ async function main() {
9
10
  installationId: githubAppInstallationId,
10
11
  privateKey: await Utils.decodeBase64EncodedString(githubAppPrivateKeyB64),
11
12
  });
13
+ const versioningClient = new VersioningClient(ghClient, VersionUpdatingStrategy.JSTS);
14
+ const rootPkgJson = await Bun.file("./package.json").json();
12
15
  await ghClient.createTag({
16
+ nextTag: await versioningClient.next(rootPkgJson.version),
13
17
  onPreTagCreate: async (tag) => {
14
18
  const file = Bun.file("./package.json");
15
19
  const pkg = await file.json();
@@ -28,8 +28,7 @@ async function main() {
28
28
  const npmClient = await NPMClient.create();
29
29
  const versioningClient = new VersioningClient(ghClient, VersionUpdatingStrategy.JSTS);
30
30
  const shortSha = await getShortSha(sha);
31
- const lastTag = (await ghClient.getLatestTag()) ?? GitHubClient.BASE_VERSION;
32
- const betaVersion = `${lastTag}-beta.${shortSha}`;
31
+ const betaVersion = await versioningClient.nextBeta(shortSha);
33
32
  if (!Utils.SemVer.validate(betaVersion)) {
34
33
  throw new Error(`Generated invalid beta version: ${betaVersion}`);
35
34
  }
@@ -23,4 +23,12 @@ export declare class VersioningClient implements IVersioningClient {
23
23
  * `baseVersion` must set patch number to `0`. (e.g. `1.0.0`, `1.5.0`, `2.0.0`, etc.)
24
24
  */
25
25
  next(baseVersion?: string, ...opts: Parameters<GitHubClient["getLatestTag"]>): Promise<string>;
26
+ /**
27
+ * generate next beta version tag using a `sha`.
28
+ *
29
+ * simply finds latest version from github and generates `{version}-beta.{sha}` to it.
30
+ *
31
+ * for example, `1.3.2-beta.58cf28bd`
32
+ */
33
+ nextBeta(sha: string, ...opts: Parameters<GitHubClient["getLatestTag"]>): Promise<string>;
26
34
  }
@@ -67,4 +67,19 @@ export class VersioningClient {
67
67
  }
68
68
  return baseVersionSemver.toString();
69
69
  }
70
+ /**
71
+ * generate next beta version tag using a `sha`.
72
+ *
73
+ * simply finds latest version from github and generates `{version}-beta.{sha}` to it.
74
+ *
75
+ * for example, `1.3.2-beta.58cf28bd`
76
+ */
77
+ async nextBeta(sha, ...opts) {
78
+ const latestTag = await this.githubClient.getLatestTag(...opts);
79
+ if (!latestTag) {
80
+ throw new Error("You must upload a tag atleast once before generating a beta tag.");
81
+ }
82
+ const latest = this.parseOrThrow("latest tag from github", latestTag);
83
+ return `${latest.toString()}-beta.${sha}`;
84
+ }
70
85
  }
@@ -21,6 +21,16 @@ export interface IVersioningClient extends IVersionUpdatingClient {
21
21
  * `baseVersion` must set patch number to `0`. (e.g. `1.0.0`, `1.5.0`, `2.0.0`, etc.)
22
22
  */
23
23
  next(baseVersion?: string): Promise<string>;
24
+ /**
25
+ * generate next beta version tag.
26
+ *
27
+ * simply finds latest version from github and generates `{version}-beta.{sha}` to it.
28
+ *
29
+ * @note you may pass in the first 8 characters of `sha` if you choose.
30
+ *
31
+ * for example, `1.3.2-beta.58cf28bd`
32
+ */
33
+ nextBeta(sha: string): Promise<string>;
24
34
  }
25
35
  export interface IJavascriptPackageJsonVersionUpdatingClient extends IVersionUpdatingClient {
26
36
  }
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "type": "module",
4
4
  "author": "Tahmid Ahmed",
5
5
  "description": "A collection of Bun shell scripts that can be re-used in various CICD pipelines.",
6
- "version": "1.0.57",
6
+ "version": "1.0.58",
7
7
  "repository": {
8
8
  "url": "git+https://github.com/tahminator/pipeline.git"
9
9
  },