Add automation for markdown spec build/lint

jdesrosiers · jdesrosiers · commit bc6466524a01 · 2024-10-21T10:35:23.000-07:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,21 +1,17 @@
 name: JSON Schema
 on:
   - push
+  - pull_request
+
 jobs:
   specs:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: "3.10"
-      - run: pip install --requirement requirements.txt
-      - run: xml2rfc --version
-      - run: make all
-      - uses: actions/upload-artifact@v3
-        with:
-          name: specification-docs
-          path: |
-              *.html
-              *.txt
-              !requirements.txt
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: latest
+        cache: npm
+    - run: npm ci
+    - run: npm run lint
+    - run: npm run build-all
diff --git a/build/build.js b/build/build.js
@@ -23,7 +23,7 @@ dotenv.config();
 
 const build = async (filename) => {
   const md = readFileSync(filename, "utf-8");
-  const html = await remark()
+  const file = await remark()
     .use(remarkPresetLintMarkdownStyleGuide)
     .use(remarkGfm)
     .use(remarkHeadingId)
@@ -164,11 +164,13 @@ const build = async (filename) => {
     </style>
   </head>
   <body>
-    ${html.toString()}
+    ${file.toString()}
   </body>
 </html>`);
 
-  console.error(reporter(html));
+  console.error(reporter(file));
+
+  return file.messages.length;
 };
 
 (async function () {
@@ -177,9 +179,14 @@ const build = async (filename) => {
     console.error("WARNING: No files built. Usage: 'npm run build -- filename.md'");
   }
 
+  let messageCount = 0;
   for (const filename of files) {
     console.log(`Building: ${filename} ...`);
-    await build(filename);
+    messageCount += await build(filename);
     console.log("");
   }
+
+  if (messageCount > 0) {
+    process.exit(1);
+  }
 }());
