newspack-scripts 1.4.4 → 1.6.0

package/README.md

@@ -19,6 +19,14 @@ Will run `calypso-build`, creating optimised production builds.
 
 Will run `calypso-build` in watch mode.
 
+### commit
+
+Uses [`commitizen`](https://www.npmjs.com/package/commitizen) to create a structured commit message.
+
+### commitlint
+
+Lints to commit message, to be used in a git `commit-msg` hook.
+
 ## Available configs
 
 This package exposes a couple of configuration files.
@@ -76,4 +84,4 @@ Install `stylelint` via npm and reference this package's config file when runnin
 stylelint '**/*.scss' --syntax scss --config=./node_modules/newspack-scripts/config/stylelint.config.js
 ```
 
-_Note: for it to work properly, use `npm` at version `>=8.3.0`._
+_Note: Due to issue with dependency resolving, you might end up a different version of `prettier` in project's `node_modules` and `node_modules/newspack-scripts/node_modules`. See https://github.com/Automattic/newspack-scripts/issues/1 for more information._

package/bin/newspack-scripts.js

@@ -4,7 +4,11 @@ const spawn = require("cross-spawn");
 
 const [scriptName, ...nodeArgs] = process.argv.slice(2);
 
-if (["test", "build", "start"].includes(scriptName)) {
+if (
+  ["test", "build", "start", "commit", "commitlint", "release"].includes(
+    scriptName
+  )
+) {
   const result = spawn.sync(
     process.execPath,
     [require.resolve("../scripts/" + scriptName), ...nodeArgs],

package/config/commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ["@commitlint/config-conventional"] };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "newspack-scripts",
-  "version": "1.4.4",
+  "version": "1.6.0",
   "description": "",
   "bin": {
     "newspack-scripts": "./bin/newspack-scripts.js"
@@ -11,13 +11,19 @@
     "@automattic/calypso-build": "^10.0.0",
     "@babel/eslint-parser": "^7.16.3",
     "@babel/preset-env": "^7.16.4",
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
     "@testing-library/jest-dom": "^5.15.1",
     "@testing-library/react": "^12.1.2",
     "@wordpress/eslint-plugin": "^9.3.0",
     "@wordpress/stylelint-config": "^19.1.0",
     "autoprefixer": "^10.4.0",
     "babel-jest": "^27.4.2",
+    "commitizen": "^4.2.4",
     "cross-spawn": "^7.0.3",
+    "cz-conventional-changelog": "^3.3.0",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.3",
@@ -28,16 +34,13 @@
     "postcss": "^8.4.4",
     "postcss-focus-within": "^5.0.1",
     "prettier": "npm:wp-prettier@2.2.1-beta-1",
-    "stylelint": "^13.3.1",
+    "semantic-release": "^18.0.1",
+    "semantic-release-version-bump": "^1.4.1",
+    "stylelint": "^14.1.0",
     "stylelint-config-prettier": "^9.0.3",
-    "stylelint-prettier": "^1.2.0",
+    "stylelint-prettier": "^2.0.0",
     "webpack": "^5.65.0"
   },
-  "overrides": {
-    "stylelint-prettier": {
-      "prettier": "npm:wp-prettier@2.2.1-beta-1"
-    }
-  },
   "scripts": {
     "semantic-release": "semantic-release"
   },
@@ -46,6 +49,6 @@
     "url": "https://github.com/Automattic/newspack-scripts.git"
   },
   "devDependencies": {
-    "semantic-release": "^18.0.1"
+    "yargs": "^17.3.0"
   }
 }

package/scripts/commit.js

@@ -0,0 +1,12 @@
+"use strict";
+
+const path = require("path");
+const bootstrap = require("commitizen/dist/cli/git-cz").bootstrap;
+const cliPath = path.resolve(require.resolve("commitizen"), "../..");
+
+bootstrap({
+  cliPath,
+  config: {
+    path: "cz-conventional-changelog",
+  },
+});

package/scripts/commitlint.js

@@ -0,0 +1,14 @@
+"use strict";
+
+const spawn = require("cross-spawn");
+const path = require("path");
+
+const result = spawn.sync(
+  `${process.cwd()}/node_modules/.bin/commitlint`,
+  ["--config", path.resolve(__dirname, "../config/commitlint.config.js")],
+  {
+    stdio: "inherit",
+  }
+);
+
+process.exit(result.status);

package/scripts/release.js

@@ -0,0 +1,108 @@
+"use strict";
+
+const spawn = require("cross-spawn");
+const path = require("path");
+
+const semanticRelease = require("semantic-release");
+
+const PROJECT_NAME = path.basename(process.cwd());
+
+const { files, ...semanticReleaseArgs } = require("yargs/yargs")(
+  process.argv.slice(2)
+).parse();
+
+const filesList = files.split(",");
+
+console.log(`Releasing ${PROJECT_NAME}…`);
+
+const config = {
+  dryRun: semanticReleaseArgs.dryRun,
+  ci: semanticReleaseArgs.ci,
+  debug: semanticReleaseArgs.debug,
+
+  branches: [
+    "release",
+    {
+      name: "alpha",
+      prerelease: "alpha",
+    },
+  ],
+  prepare: [
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    [
+      // Increment the version in additional files, and the create the release archive.
+      "semantic-release-version-bump",
+      {
+        files: filesList,
+        callback: "npm run release:archive",
+      },
+    ],
+    {
+      path: "@semantic-release/git",
+      // These assets should be added to source control after a release.
+      assets: [
+        ...filesList,
+        "package.json",
+        "package-lock.json",
+        "CHANGELOG.md",
+      ],
+      message:
+        "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
+    },
+  ],
+  plugins: [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      // Do not publish on npm.
+      "@semantic-release/npm",
+      {
+        npmPublish: false,
+      },
+    ],
+    "semantic-release-version-bump",
+    // Add the built ZIP archive to GH release.
+    [
+      "@semantic-release/github",
+      {
+        assets: [
+          {
+            path: `./release/${PROJECT_NAME}.zip`,
+            label: `${PROJECT_NAME}.zip`,
+          },
+        ],
+      },
+    ],
+  ],
+};
+
+const run = async () => {
+  try {
+    const result = await semanticRelease(config);
+
+    if (result) {
+      const { lastRelease, commits, nextRelease, releases } = result;
+
+      console.log(
+        `Published ${nextRelease.type} release version ${nextRelease.version} containing ${commits.length} commits.`
+      );
+
+      if (lastRelease.version) {
+        console.log(`The last release was "${lastRelease.version}".`);
+      }
+
+      for (const release of releases) {
+        console.log(
+          `The release was published with plugin "${release.pluginName}".`
+        );
+      }
+    } else {
+      console.log("No release published.");
+    }
+  } catch (err) {
+    console.error("The automated release failed with %O", err);
+  }
+};
+
+run();

package/scripts/utils/modules.js

@@ -1,7 +1,6 @@
 const fs = require("fs");
-const path = require("path");
 
 module.exports = {
   rootDirectory: fs.realpathSync(process.cwd()),
-  calypsoBuild: require.resolve("@automattic/calypso-build/bin/calypso-build")
+  calypsoBuild: require.resolve("@automattic/calypso-build/bin/calypso-build"),
 };