build(release): updated release behavior

Author: mlaursen

.eslintignore

@@ -1,4 +1,4 @@
+/dist
 /.next
 /public
 /node_modules
-/dist

.eslintrc.js

@@ -3,4 +3,12 @@ module.exports = {
   rules: {
     'react/react-in-jsx-scope': 0,
   },
+  overrides: [
+    {
+      files: ['scripts/*.ts'],
+      rules: {
+        'no-console': 0,
+      },
+    },
+  ],
 };

.gitignore

@@ -12,18 +12,20 @@ coverage
 
 # Dependency directories
 node_modules/
+
 # TypeScript cache
 *.tsbuildinfo
 
+# For creating github releases
+.env.github
+
+# For vercel deployments
 .env.production.local
 
 # Output of 'npm pack'
 *.tgz
 
 # generated output
+/dist
 /.next
 /public/tsdocs
-/es
-/lib
-/dist
-/types

.prettierignore

@@ -1 +1,2 @@
 CHANGELOG.md
+/node_modules

changelog.config.js

@@ -4,7 +4,7 @@ module.exports = {
   testEnvironment: 'jsdom',
   globals: {
     'ts-jest': {
-      tsconfig: './tsconfig.jest.json',
+      tsconfig: './tsconfig.node.json',
     },
   },
   moduleNameMapper: {

createEnv.js

@@ -17,19 +17,12 @@
   "scripts": {
     "prepare": "husky install",
     "prebuild": "npm-run-all -p lint typecheck api-docs create-env",
-    "clean-dist": "rimraf dist",
-    "ci": "npm-run-all lint typecheck test",
-    "create-env": "node createEnv.js",
-    "api-docs": "node ./typedoc.js",
-    "bundle": "rollup -c rollup.config.js",
-    "update-version": "standard-version",
-    "do-publish": "npm publish",
-    "push-tag": "git push --follow-tags origin main",
-    "release": "npm-run-all build-pkg update-version do-publish push-tag",
-    "typedefs": "tsc -p tsconfig.typedefs.json",
-    "build-pkg": "npm-run-all clean-dist bundle typedefs",
-    "typecheck": "tsc -p tsconfig.check.json",
+    "run-script": "ts-node -T -P tsconfig.node.json",
+    "create-env": "yarn run-script scripts/createEnv.ts",
+    "api-docs": "yarn run-script scripts/typedoc.ts",
+    "release": "yarn run-script scripts/release.ts",
     "lint": "eslint \"**/*.{js,jsx,ts,tsx}\"",
+    "typecheck": "tsc -p tsconfig.check.json",
     "test": "jest",
     "start": "next dev",
     "build": "next build"
@@ -43,24 +36,28 @@
     "@babel/preset-env": "^7.15.4",
     "@babel/preset-react": "^7.14.5",
     "@babel/preset-typescript": "^7.15.0",
-    "@mlaursen/changelog-preset": "^1.1.0",
-    "@mlaursen/eslint-config": "^1.1.4",
+    "@mlaursen/eslint-config": "^1.1.5",
     "@next/eslint-plugin-next": "^11.1.2",
+    "@octokit/core": "^3.5.1",
     "@rollup/plugin-babel": "^5.3.0",
     "@rollup/plugin-commonjs": "^20.0.0",
     "@rollup/plugin-node-resolve": "^13.0.4",
     "@rollup/plugin-replace": "^3.0.0",
     "@testing-library/jest-dom": "^5.14.1",
     "@testing-library/react": "^12.0.0",
+    "@types/inquirer": "^8.1.1",
     "@types/jest": "^27.0.1",
+    "@types/node": "^16.7.13",
     "@types/prismjs": "^1.16.6",
     "@types/react": "^17.0.19",
     "@types/react-dom": "^17.0.9",
     "babel-plugin-prismjs": "^2.1.0",
+    "dotenv": "^10.0.0",
     "eslint": "^7.32.0",
     "filesize": "^8.0.0",
     "husky": "^7.0.2",
     "identity-obj-proxy": "^3.0.0",
+    "inquirer": "^8.1.2",
     "jest": "^27.1.0",
     "jest-watch-typeahead": "^0.6.4",
     "lint-staged": "^11.1.2",
@@ -77,6 +74,7 @@
     "sass": "^1.39.0",
     "standard-version": "^9.3.1",
     "ts-jest": "^27.0.5",
+    "ts-node": "^10.2.1",
     "typedoc": "^0.21.9",
     "typedoc-plugin-sourcefile-url": "^1.0.6",
     "typescript": "^4.4.2"

jest.config.js

@@ -0,0 +1,19 @@
+// vi: ft=javascript
+import { execSync } from "child_process";
+import { writeFile } from "fs";
+
+const commitSha = execSync("git rev-parse HEAD").toString().trim();
+const gaCode = "G-JSF6GSWE18";
+
+const contents = `NEXT_PUBLIC_GA_CODE=${gaCode}
+NEXT_PUBLIC_COMMIT_SHA=${commitSha}
+`;
+
+writeFile(".env.production.local", contents, (error) => {
+  if (error) {
+    throw error;
+  }
+
+  // eslint-disable-next-line no-console
+  console.log(contents);
+});

package.json

@@ -0,0 +1,134 @@
+import { Octokit } from "@octokit/core";
+import { execSync } from "child_process";
+import dotenv from "dotenv";
+import { readFileSync } from "fs";
+import inquirer from "inquirer";
+import { join } from "path";
+
+function loggedCommand(command: string): void {
+  console.log(command);
+  execSync(command, { stdio: "inherit" });
+  console.log("");
+}
+
+function undo(version?: string): void {
+  loggedCommand("git reset HEAD^");
+  if (typeof version === "string") {
+    loggedCommand(`git tag -d v${version}`);
+  }
+}
+
+const NEW_ENTRY = /^#{1,3}\s+\[\d/;
+
+async function getReleaseNotes(version: string): Promise<string> {
+  console.log("Update the CHANGELOG.md with any additional changes.");
+  const { confirmed } = await inquirer.prompt<{ confirmed: boolean }>([
+    {
+      type: "confirm",
+      name: "confirmed",
+      message: "Continue the release?",
+    },
+  ]);
+  if (!confirmed) {
+    console.error("Canceling the release.");
+    undo(version);
+
+    process.exit(1);
+  }
+
+  const changelog = readFileSync(join(process.cwd(), "CHANGELOG.md"), "utf8");
+  const lines = changelog.split(/\r?\n/);
+  let lastEntryStart = -1;
+  let nextEntryStart = -1;
+
+  for (let i = 0; i < lines.length; i += 1) {
+    if (NEW_ENTRY.test(lines[i])) {
+      if (lastEntryStart === -1) {
+        lastEntryStart = i + 1;
+      } else if (nextEntryStart === -1) {
+        nextEntryStart = i;
+        break;
+      }
+    }
+  }
+
+  if (lastEntryStart === -1 || nextEntryStart === -1) {
+    console.error("Unable to find a release block.");
+    process.exit(1);
+  }
+
+  return lines.slice(lastEntryStart, nextEntryStart).join("\n");
+}
+
+const RELEASE_TYPES = ["major", "minor", "patch"];
+
+async function run(): Promise<void> {
+  let type = "";
+  let prerelease = "";
+  for (let i = 0; i < process.argv.length; i += 1) {
+    const flag = process.argv[i];
+    const value = process.argv[i + 1];
+    if (
+      flag === "-t" &&
+      typeof value === "string" &&
+      RELEASE_TYPES.includes(value)
+    ) {
+      type = ` --release-as ${value}`;
+    } else if (flag === "-p" || flag === "--prerelease") {
+      prerelease = " --prerelease";
+    }
+  }
+
+  const githubDotEnv = join(process.cwd(), ".env.github");
+  dotenv.config({ path: githubDotEnv });
+
+  const { GITHUB_TOKEN } = process.env;
+  if (!GITHUB_TOKEN) {
+    console.error(
+      `Missing a \`GITHUB_TOKEN\` environment variable. This should be located at:
+- ${githubDotEnv}
+
+A token can be created at:
+- https://github.com/settings/tokens/new?scopes=repo
+`
+    );
+
+    process.exit(1);
+  }
+
+  loggedCommand("yarn lint");
+  loggedCommand("yarn typecheck");
+  loggedCommand("yarn test");
+  loggedCommand("yarn rimraf dist");
+  loggedCommand("yarn rollup -c rollup.config.js");
+  loggedCommand("yarn tsc -p tsconfig.typedefs.json");
+  loggedCommand(`yarn standard-version --preset angular${type}${prerelease}`);
+
+  const { version } = JSON.parse(
+    readFileSync(join(process.cwd(), "package.json"), "utf8")
+  );
+  if (typeof version !== "string") {
+    console.error("Unable to get the package version.");
+    undo();
+    process.exit(1);
+  }
+
+  const releaseNotes = await getReleaseNotes(version);
+
+  loggedCommand("npm publish");
+  loggedCommand("git push --follow-tags origin main");
+  const octokit = new Octokit({ auth: GITHUB_TOKEN });
+  const response = await octokit.request(
+    "POST /repos/{owner}/{repo}/releases",
+    {
+      owner: "mlaursen",
+      repo: "react-marked-renderer",
+      tag_name: `v${version}`,
+      body: releaseNotes,
+    }
+  );
+
+  console.log(`Created release: ${response.data.html_url}`);
+}
+
+run();