Merge pull request #112 from cloudnode-pro/publish-workflow

NPM publish workflow

Author: zefir-git

.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish-npm:
+    name: Publish to npm
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          registry-url: https://registry.npmjs.org/
+          cache: npm
+      - run: npm install -g npm@latest
+      - run: npm ci
+      - run: npm version ${TAG_NAME} --git-tag-version=false
+        env:
+          TAG_NAME: ${{ github.event.release.tag_name }}
+      - run: npm run generate; npm run readme
+      - run: npm --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

README.md

@@ -1,9 +1,10 @@
 # Cloudnode API Client
 
-![Client Version: 3.0.0](https://img.shields.io/badge/Client%20Version-3.0.0-%2316a34a)
+[![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)
-![npm downloads](https://img.shields.io/npm/dt/cloudnode-ts?label=downloads)
+[![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)
 
 A client library for the Cloudnode API, written in TypeScript. [Documentation](https://github.com/cloudnode-pro/ts-client#documentation)
 

README.template.md

@@ -3,6 +3,7 @@
 {{{shield.version}}}
 {{{shield.apiVersion}}}
 {{{shield.build}}}
+{{{shield.codeQl}}}
 {{{shield.downloads}}}
 
 {{pkg.description}}

browser/Cloudnode.js

@@ -35,7 +35,7 @@ class Cloudnode {
     /**
      * Client user agent
      */
-    #userAgent = `cloudnode/2.1.0`;
+    #userAgent = `cloudnode/0.0.0-dev`;
     /**
      * Construct a new Cloudnode API client
      * @param token API token to use for requests

browser/Cloudnode.min.js

@@ -240,10 +240,11 @@ export async function generateReadme (docMD: string, config: Config, pkg: Packag
         });
     });
     const shield = {
-        version: `![Client Version: ${pkg.version}](https://img.shields.io/badge/Client%20Version-${pkg.version}-%2316a34a)`,
+        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"})`,
-        downloads: `![npm downloads](https://img.shields.io/npm/dt/cloudnode-ts?label=downloads)`
+        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);

gen/docs.ts

@@ -1,15 +1,14 @@
 {
   "name": "cloudnode-ts",
-  "version": "3.0.0",
+  "version": "0.0.0-dev",
   "description": "A client library for the Cloudnode API, written in TypeScript. [Documentation](https://github.com/cloudnode-pro/ts-client#documentation)",
   "main": "src/Cloudnode.js",
   "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc",
     "generate": "./scripts/generate.sh",
-    "readme": "node ./gen/readme.js",
-    "tag": "node scripts/tag"
+    "readme": "node ./gen/readme.js"
   },
   "repository": {
     "type": "git",

package-lock.json

@@ -35,7 +35,7 @@ class Cloudnode {
     /**
      * Client user agent
      */
-    #userAgent = `cloudnode/2.1.0`;
+    #userAgent = `cloudnode/0.0.0-dev`;
     /**
      * Construct a new Cloudnode API client
      * @param token API token to use for requests