diff is useful

Author: eps1lon

.github/workflows/main.yml

@@ -29,4 +29,6 @@ jobs:
         run: yarn format:check
 
       - name: "`yarn gen-readme` changes committed?"
-        run: yarn gen-readme --check
+        run: |
+          yarn gen-readme
+          git diff --exit-code

genReadme.js

@@ -330,27 +330,14 @@ async function main(argv) {
     filepath: path.basename(readmePath),
   });
 
-  if (argv.check) {
-    if (pendingReadme !== currentReadme) {
-      throw new Error("Readme is outdated. Forgot to run `yarn gen-readme`?");
-    }
-  } else {
-    await fs.writeFile(readmePath, pendingReadme);
-  }
+  await fs.writeFile(readmePath, pendingReadme);
 }
 
 yargs(hideBin(process.argv))
   .command({
     command: "$0",
     describe: "Generate the README.md from docs/ folder",
     handler: main,
-    builder: (yargs) => {
-      return yargs.option("check", {
-        type: "boolean",
-        description:
-          "Exits with 1 if the current README.md is out-of-date and should be regenerated.",
-      });
-    },
   })
   .usage("node $0 [args]")
   .help()