Merge pull request #115 from cloudnode-pro/build-workflow

Update and rename build workflow

Author: zefir-git

.github/workflows/test.yml .github/workflows/build.yml.github/workflows/test.yml renamed to .github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Test
+name: Build
 'on':
   pull_request:
     types: [ opened, synchronize, reopened ]
@@ -12,8 +12,8 @@ jobs:
     strategy:
       matrix:
         node:
+          - 20
           - 18
-          - 16
     steps:
       - uses: actions/setup-node@v1
         with:

README.md

@@ -2,7 +2,7 @@
 
 [![npm](https://img.shields.io/npm/v/cloudnode-ts)](https://www.npmjs.com/package/cloudnode-ts)
 ![API Version: 5.13.0](https://img.shields.io/badge/API%20Version-5.13.0-%232563eb)
-![build: passing](https://img.shields.io/badge/build-passing-%2316a34a)
+[![Build](https://github.com/cloudnode-pro/ts-client/actions/workflows/build.yml/badge.svg)](https://github.com/cloudnode-pro/ts-client/actions/workflows/build.yml)
 [![CodeQL](https://github.com/cloudnode-pro/ts-client/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/cloudnode-pro/ts-client/actions/workflows/github-code-scanning/codeql)
 [![npm downloads](https://img.shields.io/npm/dt/cloudnode-ts?label=downloads)](https://www.npmjs.com/package/cloudnode-ts)
 

README.template.md

@@ -1,10 +1,10 @@
 # {{config.name}} API Client
 
-{{{shield.version}}}
+[![npm](https://img.shields.io/npm/v/cloudnode-ts)](https://www.npmjs.com/package/cloudnode-ts)
 {{{shield.apiVersion}}}
-{{{shield.build}}}
-{{{shield.codeQl}}}
-{{{shield.downloads}}}
+[![Build](https://github.com/cloudnode-pro/ts-client/actions/workflows/build.yml/badge.svg)](https://github.com/cloudnode-pro/ts-client/actions/workflows/build.yml)
+[![CodeQL](https://github.com/cloudnode-pro/ts-client/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/cloudnode-pro/ts-client/actions/workflows/github-code-scanning/codeql)
+[![npm downloads](https://img.shields.io/npm/dt/cloudnode-ts?label=downloads)](https://www.npmjs.com/package/cloudnode-ts)
 
 {{pkg.description}}
 

gen/docs.ts

@@ -5,7 +5,6 @@ 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";
 import * as crypto from "crypto";
 
 /**
@@ -233,18 +232,8 @@ export function generateMarkdownDocs (config: Config, schema: Schema, docSchema:
  */
 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) => {
-        child_process.exec("npm run build", (error) => {
-            resolve(!error);
-        });
-    });
     const shield = {
-        version: `[![npm](https://img.shields.io/npm/v/cloudnode-ts)](https://www.npmjs.com/package/cloudnode-ts)`,
         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"})`,
-        codeQl: "[![CodeQL](https://github.com/cloudnode-pro/ts-client/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/cloudnode-pro/ts-client/actions/workflows/github-code-scanning/codeql)",
-        downloads: `[![npm downloads](https://img.shields.io/npm/dt/cloudnode-ts?label=downloads)](https://www.npmjs.com/package/cloudnode-ts)`,
     };
     const rendered = Mustache.render(template, {config, pkg, docMD, shield});
     await fs.writeFile("README.md", rendered);