Merge pull request #14 from cloudnode-pro/build-test

Test whether the project builds successfully

Author: williamd5

.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Test
+'on':
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+  push:
+    branches:
+      - 'main'
+jobs:
+  test:
+    name: 'Build with Node.js v${{ matrix.node }}'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node:
+          - 18
+          - 16
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '${{ matrix.node }}'
+      - uses: actions/checkout@v2
+      - name: 'Cache node_modules'
+        uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-v${{ matrix.node }}-${{ hashFiles('**/package.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-v${{ matrix.node }}-
+      - name: Install Dependencies
+        run: npm install
+      - name: Build
+        run: npm run build

README.md

@@ -2,6 +2,7 @@
 
 ![Client Version: 1.5.0](https://img.shields.io/badge/Client%20Version-1.5.0-%2316a34a)
 ![API Version: 5.7.1](https://img.shields.io/badge/API%20Version-5.7.1-%232563eb)
+![build: passing](https://img.shields.io/badge/build-passing-%2316a34a)
 
 A client SDK for the Cloudnode API, written in TypeScript. [Documentation](https://github.com/cloudnode-pro/ts-client#documentation)
 

README.template.md

@@ -2,6 +2,7 @@
 
 {{{shield.version}}}
 {{{shield.apiVersion}}}
+{{{shield.build}}}
 
 {{pkg.description}}
 

gen/docs.ts

@@ -5,6 +5,7 @@ import DocSchema from "./DocSchema.js";
 import fs from "node:fs/promises";
 import Package from "./Package";
 import Mustache from "mustache";
+import * as child_process from "child_process";
 
 /**
  * Generate doc schema
@@ -92,10 +93,17 @@ export function generateMarkdownDocs (schema: DocSchema, tableOfContents: boolea
  */
 export async function generateReadme (docMD: string, config: Config, pkg: Package): Promise<void> {
     const template = await fs.readFile("README.template.md", "utf8");
+    // check if project builds successfully
+    const buildStatus = await new Promise((resolve, reject) => {
+        child_process.exec("npm run build", (error, stdout, stderr) => {
+            resolve(!error);
+        });
+    });
     const shield = {
         version: `![Client Version: ${pkg.version}](https://img.shields.io/badge/Client%20Version-${pkg.version}-%2316a34a)`,
-        apiVersion: `![API Version: ${config.apiVersion}](https://img.shields.io/badge/API%20Version-${config.apiVersion}-%232563eb)`
-    }
+        apiVersion: `![API Version: ${config.apiVersion}](https://img.shields.io/badge/API%20Version-${config.apiVersion}-%232563eb)`,
+        build: `![build: ${buildStatus ? "passing" : "failing"}](https://img.shields.io/badge/build-${buildStatus ? "passing" : "failing"}-%23${buildStatus ? "16a34a" : "dc2626"})`
+    };
     const rendered = Mustache.render(template, {config, pkg, docMD, shield});
     await fs.writeFile("README.md", rendered);
 }