ci: unify GHA build process (#1172)

a few small behind-the-scenes changes to simplify how we build `rdme`
for GitHub Actions users — no actual customer impact here. quick
breakdown of the changes:

- [x] replaces `@rollup/plugin-terser` with `rollup-plugin-esbuild` for
minifying our GitHub Actions code. the latter accomplishes basically the
same result as the former, but in a tiny fraction of the time.
- [x] we previously forked our GHA build process into a development vs.
production setup since terser takes so long. since
`rollup-plugin-esbuild` adds a negligible amount of time to our build
process, there's no need to have two setups. this PR combines them into
a single build process.
- [x] added a bunch of steps to our CI to further assert that the GitHub
Actions build is what we expect.

does CI still pass?

Author: kanadgupta

.github/workflows/ci.yml

@@ -71,9 +71,14 @@ jobs:
       #
       # This step is not required for syncing your docs to ReadMe!
       - name: Rebuild GitHub Action for testing purposes
-        run: npm ci && npm run build:gha
+        # We manually invoke `bin/write-gha-pjson.js` here because
+        # GitHub Actions does not support `pre` scripts for local actions.
+        run: npm ci && npm run build:gha && bin/write-gha-pjson.js
         working-directory: rdme-repo
 
+      - name: Run root command
+        uses: ./rdme-repo/
+
       - name: Run `openapi validate` command
         uses: ./rdme-repo/
         with:
@@ -98,11 +103,28 @@ jobs:
 
       - name: Assert that previous validation step failed
         if: ${{ steps.openapi-validate-fail.outcome == 'failure' }}
-        run: echo "The validation in the previous step failed as expected."
+        run: echo "The previous step failed as expected."
 
       - name: Throw error if previous validation step did not fail
         if: ${{ steps.openapi-validate-fail.outcome == 'success' }}
-        run: echo "::error::Expected validation in previous step to fail" && exit 1
+        run: echo "::error::Expected previous step to fail" && exit 1
+
+      # The `help` command is only available in the CLI.
+      # This step should fail because `help` does not exist in GitHub Actions
+      - name: Run `help`
+        uses: ./rdme-repo/
+        id: help-fail
+        continue-on-error: true
+        with:
+          rdme: help
+
+      - name: Assert that previous step failed
+        if: ${{ steps.help-fail.outcome == 'failure' }}
+        run: echo "The previous step failed as expected."
+
+      - name: Throw error if previous step did not fail
+        if: ${{ steps.help-fail.outcome == 'success' }}
+        run: echo "::error::Expected previous step to fail" && exit 1
 
       # Docs: https://rdme-test.readme.io
       - name: Run `openapi` command

package-lock.json

@@ -80,7 +80,6 @@
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^16.0.0",
     "@rollup/plugin-replace": "^6.0.1",
-    "@rollup/plugin-terser": "^0.4.4",
     "@types/configstore": "^6.0.0",
     "@types/debug": "^4.1.7",
     "@types/js-yaml": "^4.0.5",
@@ -103,6 +102,7 @@
     "openapi-types": "^12.1.3",
     "prettier": "^3.0.2",
     "rollup": "^4.3.0",
+    "rollup-plugin-esbuild": "^6.2.0",
     "tsx": "^4.19.2",
     "type-fest": "^4.3.1",
     "typescript": "^5.1.6",
@@ -112,7 +112,6 @@
     "build": "tsc && cp package.json dist/package.json",
     "build:docs": "oclif readme --multi --output-dir documentation/commands --no-aliases",
     "build:gha": "npm run build && rollup --config",
-    "build:gha:prod": "npm run build:gha -- --environment PRODUCTION_BUILD",
     "lint": "alex . && knip && npm run lint:ts && npm run prettier && npm run schemas:check",
     "lint:ts": "eslint . --ext .js,.ts",
     "prebuild": "rm -rf dist/ && rm -f src/package.json && ln package.json src/package.json",
@@ -123,7 +122,7 @@
     "schemas:check": "./bin/json-schema-store.js",
     "schemas:write": "./bin/json-schema-store.js --update",
     "test": "vitest run --coverage",
-    "version": "npm run build:gha:prod && oclif manifest && npm run build:docs"
+    "version": "npm run build:gha && oclif manifest && npm run build:docs"
   },
   "commitlint": {
     "extends": [

package.json

@@ -1,11 +1,10 @@
+// @ts-check
 import commonjs from '@rollup/plugin-commonjs';
 import json from '@rollup/plugin-json';
 import { nodeResolve } from '@rollup/plugin-node-resolve';
 import replace from '@rollup/plugin-replace';
-import terser from '@rollup/plugin-terser';
 import { defineConfig } from 'rollup';
-
-const isProductionBuild = process.env.PRODUCTION_BUILD === 'true';
+import { minify } from 'rollup-plugin-esbuild';
 
 const basePlugins = [
   commonjs(),
@@ -16,14 +15,9 @@ const basePlugins = [
     exportConditions: ['node'],
     preferBuiltins: true,
   }),
+  minify(),
 ];
 
-// only minify when doing a "production" build (i.e., for a release)
-// it takes a lot longer!
-if (isProductionBuild) {
-  basePlugins.push(terser());
-}
-
 export default defineConfig([
   {
     input: 'bin/run.js',