@frsource/release-it-config 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+
+
+## [1.0.2](https://github.com/FRSOURCE/toolkit/compare/@frsource/release-it-config-v1.0.1...${npm.name}-v1.0.2) (2024-04-19)
+
+## [1.0.1](https://github.com/FRSOURCE/toolkit/compare/@frsource/release-it-config-v1.0.0...${npm.name}-v1.0.1) (2024-04-18)
+
+# 1.0.0 (2024-04-18)

package/monorepoIndependent.cjs

@@ -1,59 +1,70 @@
-const nodePath = require("path");
+const path = require("path");
 
 /**
  * Configuration for independent package in monorepo workspace
  * @param {Object} options
- * @param {string} options.name name of the package in the monorepo, e.g. `my-package`
- * @param {string} [options.path=`packages/${options.name}`] path of the package relative to the monorepo root, without starting slash. Always use "/" as delimiter. Will default to `packages/${options.name}`
+ * @param {string} options.pkgName name of the package in the monorepo, e.g. `@frsource/my-package`
+ * @param {string} [options.path=`packages/${options.pkgName}`] path of the package relative to the monorepo root, without starting slash. Always use "/" as delimiter. Will default to `packages/${options.pkgName}` (package scope in `options.pkgName` will be omitted)
  * @param {string} [options.buildCmd="pnpm build"] command that should be used to build the package, defaults to `pnpm build`
  */
 module.exports = ({
-  name,
-  path = `packages/${name}`,
+  pkgName,
+  path: pkgPath = `packages/${pkgName.substring(pkgName.lastIndexOf("/") + 1)}`,
   buildCmd = "pnpm build",
+  /**
+   * @private (for internal usage)
+   */
+  pluginsPath = "@frsource/release-it-config",
 }) => {
-  if (path.startsWith("/")) path = path.substring(1);
-  const nestingLevel = path.split("/").length;
-  if (nodePath.sep !== "/") path = path.replaceAll("/", nodePath.sep);
+  if (pkgPath.startsWith("/")) pkgPath = pkgPath.substring(1);
+  const nestingLevel = pkgPath.split("/").length;
+  if (path.sep !== "/") pkgPath = pkgPath.replaceAll("/", path.sep);
 
   return {
     npm: {
-      publishPath: "package-pack.tgz",
+      publishPath: "*.tgz",
+      publish: true,
     },
     git: {
       requireBranch: "main",
-      requireCommits: true,
+      requireCommits: false,
       requireCommitsFail: false, // if there are no new commits release-it will stop the release process, but without throwing and error
       requireCleanWorkingDir: true,
       commitsPath: ".",
-      commitMessage: "chore: release ${npm.name} ${version}",
+      commitMessage: "chore(release): ${npm.name} v${version}",
       tagName: "${npm.name}-v${version}",
       tagMatch: "${npm.name}-v[0-9]*.[0-9]*.[0-9]*",
       getLatestTagFromAllRefs: false, // https://github.com/release-it/release-it/blob/main/docs/git.md#use-all-refs-to-determine-latest-tag
     },
     github: {
       release: true,
+      releaseName: `${pkgName}@\${version}`,
       comments: {
-        submit: true,
+        submit: false, // hitting the secondary rate limit issues, see:
+        // https://github.com/FRSOURCE/toolkit/actions/runs/8730568392/job/23954615077#step:8:38
         issue:
-          ":rocket: _This issue has been resolved in ${npm.name}@${version}. See [${releaseName}](${releaseUrl}) for release notes._",
-        pr: ":rocket: _This pull request is included in ${npm.name}@${version}. See [${releaseName}](${releaseUrl}) for release notes._",
+          ":rocket: _This issue has been resolved in [${releaseName} (click for release notes)](${releaseUrl})._",
+        pr: ":rocket: _This pull request is included in [${releaseName} (click for release notes)](${releaseUrl})._",
       },
     },
     plugins: {
       "@release-it/conventional-changelog": {
         gitRawCommitsOpts: {
-          path,
+          path: pkgPath,
         },
+        preset: "angular",
+        infile: "CHANGELOG.md",
       },
+      [`${pluginsPath}/version-plugin.mjs`]: {},
     },
     hooks: {
       "before:bump": buildCmd,
-      "after:bump": `pnpm install && git add ${"../".repeat(
-        nestingLevel
-      )}pnpm-lock.yaml`,
-      "before:npm:release": "mv $(pnpm pack) package-pack.tgz",
-      "after:npm:release": "rm package-pack.tgz",
+      "after:bump": [
+        "pnpm install",
+        `git add ${"../".repeat(nestingLevel)}pnpm-lock.yaml`,
+      ],
+      "before:npm:release": "pnpm pack",
+      "after:npm:release": "rm *.tgz",
     },
   };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frsource/release-it-config",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "index.cjs",
   "type": "module",
   "dependencies": {

package/version-plugin.mjs

@@ -0,0 +1,94 @@
+import { Plugin } from "release-it";
+import { existsSync, readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { tmpdir, EOL } from "node:os";
+
+const VERSION_BUMP_INFO_PATH = join(tmpdir(), "FRSOURCE_VERSION_BUMP");
+const docs = "https://git.io/release-it-git";
+
+const toUnique = (array) => [...new Set(array)];
+const flattenDependencies = (infoObj, result = []) => {
+  if (infoObj?.dependencies) {
+    for (const [key, internalInfoObj] of Object.entries(infoObj.dependencies)) {
+      result.push(key);
+      flattenDependencies(internalInfoObj, result);
+    }
+  }
+  return result;
+};
+const e = (message, docs, fail = true) => {
+  const error = new Error(
+    docs ? `${message}${EOL}Documentation: ${docs}${EOL}` : message
+  );
+  error.code = fail ? 1 : 0;
+  return error;
+};
+
+export default class FRSVersionPlugin extends Plugin {
+  async getLatestVersion() {
+    this.log.log("Reading version file from:", VERSION_BUMP_INFO_PATH);
+    const gitOptions = this.config.getContext()?.git ?? {};
+
+    const shouldBeIncremented = await this.shouldBeIncremented();
+    const commitsSinceLatestTag = await this.getCommitsSinceLatestTag(
+      gitOptions.commitsPath
+    );
+
+    // check commit requirement only when package doesn't need to be bumped because of workspace cross-dependencies
+    if (!shouldBeIncremented && commitsSinceLatestTag === 0) {
+      throw e(
+        `There are no commits since the latest tag.`,
+        docs,
+        gitOptions.requireCommitsFail
+      );
+    }
+  }
+
+  afterRelease() {
+    writeFileSync(
+      VERSION_BUMP_INFO_PATH,
+      `${this.config.getContext("name")}\n`,
+      {
+        flag: "as",
+      }
+    );
+  }
+
+  async shouldBeIncremented() {
+    const recentlyBumpedPackages = this.getRecentlyBumpedPackages();
+    const workspaceDependencies = await this.getWorkspaceDependencies();
+
+    this.debug({ recentlyBumpedPackages, workspaceDependencies });
+
+    return workspaceDependencies.some((depName) =>
+      recentlyBumpedPackages.includes(depName)
+    );
+  }
+
+  async getWorkspaceDependencies() {
+    const packageInfoRaw = await this.exec(
+      "pnpm list --only-projects --depth Infinity --json -P",
+      { options: { write: false } }
+    );
+    const packageInfo = toUnique(JSON.parse(packageInfoRaw));
+    return flattenDependencies(packageInfo?.[0]);
+  }
+
+  getRecentlyBumpedPackages() {
+    if (!existsSync(VERSION_BUMP_INFO_PATH)) return [];
+    return toUnique(
+      readFileSync(VERSION_BUMP_INFO_PATH, "utf-8")
+        .split("\n")
+        .slice(1)
+        .filter(Boolean)
+    );
+  }
+
+  async getCommitsSinceLatestTag(commitsPath = "") {
+    const { latestTag } = this.config.getContext();
+    const ref = latestTag ? `${latestTag}..HEAD` : "HEAD";
+    return this.exec(`git rev-list ${ref} --count ${commitsPath}`, {
+      options: { write: false },
+    }).then(Number);
+  }
+}