newspack-scripts 4.4.0 → 4.5.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newspack-scripts",
-  "version": "4.4.0",
+  "version": "4.5.0-alpha.2",
   "description": "",
   "bin": {
     "newspack-scripts": "./bin/newspack-scripts.js"
@@ -58,6 +58,7 @@
     "prettier": "npm:wp-prettier@^2.6.2-beta-1",
     "semantic-release": "^19.0.5",
     "semantic-release-version-bump": "^1.4.1",
+    "slugg": "^1.2.1",
     "stylelint": "^14.1.0",
     "stylelint-config-prettier": "^9.0.3",
     "stylelint-prettier": "^2.0.0",

package/scripts/release.js

@@ -3,6 +3,7 @@
 const spawn = require("cross-spawn");
 const path = require("path");
 const utils = require("./utils/index.js");
+const slugg = require("slugg");
 
 const semanticRelease = require("semantic-release");
 
@@ -20,39 +21,67 @@ if (shouldPublishOnNPM) {
   utils.log(`Will publish on npm`);
 }
 
-const config = {
-  dryRun: otherArgs.dryRun,
-  ci: otherArgs.ci,
-  debug: otherArgs.debug,
-
-  branches: [
-    // `release` branch is published on the main distribution channel (a new version on GH).
-    "release",
-    // `alpha` branch – for regular pre-releases.
-    {
-      name: "alpha",
-      prerelease: true,
-    },
-    // `hotfix/*` branches – for releases outside of the release schedule.
-    {
-      name: "hotfix/*",
-      // With `prerelease: true`, the `name` would be used for the pre-release tag. A name with a `/`
-      // is not valid, though. See https://semver.org/#spec-item-9.
-      prerelease: "hotfix",
-    },
-  ],
-  prepare: [
-    "@semantic-release/changelog",
-    "@semantic-release/npm",
-    [
+const getConfig = ({ gitBranchName }) => {
+  const config = {
+    dryRun: otherArgs.dryRun,
+    ci: otherArgs.ci,
+    debug: otherArgs.debug,
+
+    branches: [
+      // `release` branch is published on the main distribution channel (a new version on GH).
+      "release",
+      // `alpha` branch – for regular pre-releases.
+      {
+        name: "alpha",
+        prerelease: true,
+      },
+      // `hotfix/*` branches – for releases outside of the release schedule.
+      {
+        name: "hotfix/*",
+        // With `prerelease: true`, the `name` would be used for the pre-release tag. A name with a `/`
+        // is not valid, though. See https://semver.org/#spec-item-9.
+        prerelease: slugg(gitBranchName),
+      },
+    ],
+    prepare: ["@semantic-release/changelog", "@semantic-release/npm"],
+    plugins: [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      [
+        // Whether to publish on npm.
+        "@semantic-release/npm",
+        {
+          npmPublish: shouldPublishOnNPM,
+        },
+      ],
+      "semantic-release-version-bump",
+      // Add the built ZIP archive to GH release.
+      [
+        "@semantic-release/github",
+        {
+          assets: [
+            {
+              path: `./release/${process.env.CIRCLE_PROJECT_REPONAME}.zip`,
+              label: `${process.env.CIRCLE_PROJECT_REPONAME}.zip`,
+            },
+          ],
+        },
+      ],
+    ],
+  };
+
+  // Unless on a hotfix branch, add a commit that updates the files.
+  if (gitBranchName.indexOf("hotfix/") !== 0) {
+    utils.log(`Plugin files and the changelog will be updated.`);
+    config.prepare.push([
       // Increment the version in additional files, and the create the release archive.
       "semantic-release-version-bump",
       {
         files: filesList,
         callback: "npm run release:archive",
       },
-    ],
-    {
+    ]);
+    config.prepare.push({
       path: "@semantic-release/git",
       // These assets should be added to source control after a release.
       assets: [
@@ -63,37 +92,23 @@ const config = {
       ],
       message:
         "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
-    },
-  ],
-  plugins: [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    [
-      // Whether to publish on npm.
-      "@semantic-release/npm",
-      {
-        npmPublish: shouldPublishOnNPM,
-      },
-    ],
-    "semantic-release-version-bump",
-    // Add the built ZIP archive to GH release.
-    [
-      "@semantic-release/github",
-      {
-        assets: [
-          {
-            path: `./release/${process.env.CIRCLE_PROJECT_REPONAME}.zip`,
-            label: `${process.env.CIRCLE_PROJECT_REPONAME}.zip`,
-          },
-        ],
-      },
-    ],
-  ],
+    });
+  } else {
+    utils.log(
+      `This is a hotfix branch, plugin files and the changelog will *not* be updated.`
+    );
+  }
+
+  return config;
 };
 
 const run = async () => {
   try {
-    const result = await semanticRelease(config);
+    const gitBranch = await utils.getGitBranch();
+
+    const result = await semanticRelease(
+      getConfig({ gitBranchName: gitBranch })
+    );
 
     if (result) {
       const { lastRelease, commits, nextRelease, releases } = result;

package/scripts/utils/index.js

@@ -1,3 +1,5 @@
+const { exec } = require("child_process");
+
 const { version } = require("../../package.json");
 
 const log = (content, type) => {
@@ -6,6 +8,18 @@ const log = (content, type) => {
   );
 };
 
+const getGitBranch = () =>
+  new Promise((resolve, reject) => {
+    return exec("git rev-parse --abbrev-ref HEAD", (err, stdout) => {
+      if (err) {
+        reject(`getGitBranch Error: ${err}`);
+      } else if (typeof stdout === "string") {
+        resolve(stdout.trim());
+      }
+    });
+  });
+
 module.exports = {
   log,
+  getGitBranch,
 };