@frsource/release-it-config 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+
+
+## [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

@@ -3,13 +3,13 @@ const nodePath = 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 = `packages/${pkgName.substring(pkgName.lastIndexOf("/") + 1)}`,
   buildCmd = "pnpm build",
 }) => {
   if (path.startsWith("/")) path = path.substring(1);
@@ -19,6 +19,7 @@ module.exports = ({
   return {
     npm: {
       publishPath: "package-pack.tgz",
+      publish: true,
     },
     git: {
       requireBranch: "main",
@@ -26,18 +27,20 @@ module.exports = ({
       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: {
@@ -45,13 +48,16 @@ module.exports = ({
         gitRawCommitsOpts: {
           path,
         },
+        preset: "angular",
+        infile: "CHANGELOG.md",
       },
     },
     hooks: {
       "before:bump": buildCmd,
-      "after:bump": `pnpm install && git add ${"../".repeat(
-        nestingLevel
-      )}pnpm-lock.yaml`,
+      "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",
     },

package/package.json

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