feat: Feature to perform npmjs release (#74)

Author: kevinshahfws

.github/workflows/release-github.yml

@@ -88,39 +88,47 @@ jobs:
           npm run dist
       - name: Check if semantic-release created a build
         id: check_build
-        uses: andstor/file-existence-action@v2
+        uses: actions/github-script@v6
         with:
-          files: './src/sdks/ripple/dist/lib/firebolt-ripple.mjs'
-
+          script: |
+            const fs = require('fs');
+            const path = './src/sdks/lifecycle-manager/dist/lib/lifecycle-manager.mjs';
+            return fs.existsSync(path);
+      - name: File Existence Output
+        run: |
+          echo "File exists: ${{ steps.check_build.outputs.result }}"
       - name: Get version from package.json
         run: |
           RELEASE_VERSION=$(node -p "require('./package.json').version")
           echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV
           echo "build_cpp_source=true" >> $GITHUB_ENV
       - name: Set cpp build source Condition
-        if: steps.check_build.outputs.files_exists == 'false' || (github.ref_name == 'main' && github.event_name != 'pull_request' && github.event_name != 'workflow_dispatch')
+        if: steps.check_build.outputs.result == 'false' || (github.ref_name == 'main' && github.event_name != 'pull_request' && github.event_name != 'workflow_dispatch')
         run: echo "build_cpp_source=false" >> $GITHUB_ENV
-      - name: Generate and configure SSH key
+      - name: Release Firebolt SDKs to NPM
+        if: steps.check_build.outputs.result == 'true' && github.event_name != 'pull_request' && (github.ref_name != 'main' || github.event_name == 'workflow_dispatch')
+        env:
+          NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN  }} # <-- Allows semantic-release to publish to npm without 2 factor auth.
         run: |
-          mkdir -p /root/.ssh
-          echo "${{ secrets.SSH_PRIVATE_KEY }}" > /root/.ssh/id_ed25519
-          chmod 600 /root/.ssh/id_ed25519
-
-          touch /root/.ssh/known_hosts
-          chmod 644 /root/.ssh/known_hosts
-          ssh-keyscan github.com >> /root/.ssh/known_hosts
-          chmod 644 /root/.ssh/known_hosts
+          npm --version
+          echo "NPM DIST TAG :: " $NPM_DIST_TAG
+          npm publish --tag $NPM_DIST_TAG --workspaces --access=public
+      - name: Dry-run Firebolt SDKs to NPM
+        if: steps.check_build.outputs.result == 'true' && (github.ref_name == 'main' && github.event_name != 'workflow_dispatch')
+        env:
+          NPM_TOKEN: ${{ secrets.SEMANTIC_RELEASE_NPM_TOKEN  }} # <-- Allows semantic-release to publish to npm without 2 factor auth.
+        run: npm publish --tag $NPM_DIST_TAG --workspaces --dry-run
 
       # - name: Checkout firebolt GitHub.io repository
-      #   if: steps.check_build.outputs.files_exists == 'true'
+      #   if: steps.check_build.outputs.result == 'true'
       #   env:
       #     GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_BOT_PAT }} # <-- Allows semantic-release-bot to push changes to protected branches
       #     PRIVATE_KEY: ${{inputs.PRIVATE_KEY}}
       #   run: |
       #     cd /tmp
-      #     git clone git@github.com:rdkcentral/ripple-doc.git ./firebolt-docs
+      #     git clone git@github.com:rdkcentral/lifecycle-manager-doc.git ./firebolt-docs
       # - name: Release docs to GitHub.io
-      #   if: steps.check_build.outputs.files_exists == 'true' && (github.ref_name == 'main' || github.ref_name == 'next' || github.ref_name == 'next-major' || github.event_name == 'pull_request')
+      #   if: steps.check_build.outputs.result == 'true' && (github.ref_name == 'main' || github.ref_name == 'next' || github.ref_name == 'next-major' || github.event_name == 'pull_request')
       #   env:
       #     GITHUB_TOKEN: ${{ secrets.SEMANTIC_RELEASE_BOT_PAT }} # <-- Allows semantic-release-bot to push changes to protected branches
       #   run: |

.gitignore

@@ -1,8 +1,8 @@
 build/*
 dist/*
-src/sdks/ripple/dist/*
-src/sdks/ripple/build/*
-src/sdks/ripple/test/transpiled-suite
+src/sdks/lifecycle-manager/dist/*
+src/sdks/lifecycle-manager/build/*
+src/sdks/lifecycle-manager/test/transpiled-suite
 node_modules/*
 test/transpiled-suite
 .DS_Store

NOTICE

@@ -1,4 +1,4 @@
-[ripple-rpc]
+[lifecycle-manager]
 Copyright 2021 Comcast Cable Communications Management, LLC
 
 Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.

README.md

@@ -1,4 +1,4 @@
 ---
-title: Ripple RPC
+title: Lifecycle Manager
 ---
-Private Ripple RPC API for distributor integration.
+Private Lifecycle Manager API for distributor integration.

package-lock.json

@@ -1,12 +1,12 @@
 {
-  "name": "@firebolt-js/ripple-rpc",
+  "name": "@firebolt-js/lifecycle-manager",
   "version": "1.1.0-next.1",
-  "description": "A Ripple specific RPC definition",
-  "main": "./dist/lib/ripple-rpc.mjs",
-  "types": "./dist/lib/ripple-rpc.d.ts",
+  "description": "A lifecycle-manager specific RPC definition",
+  "main": "./dist/lib/lifecycle-manager.mjs",
+  "types": "./dist/lib/lifecycle-manager.d.ts",
   "type": "module",
   "workspaces": [
-    "src/sdks/ripple"
+    "src/sdks/lifecycle-manager"
   ],
   "scripts": {
     "fs:setup": "npm run clean && mkdir -p dist",
@@ -57,6 +57,7 @@
   },
   "keywords": [
     "firebolt",
+    "lifecycle-manager",
     "ripple"
   ],
   "license": "Apache-2.0"

package.json

@@ -117,7 +117,7 @@ const capabilities = () => {
 
     let manifest = '\n'
 
-    const linkify = (method) => `[${method}](./ripple/${method.split('.').shift()}/#${method.match(/\.on[A-Z]/) ? method.split('.').pop().charAt(2).toLowerCase() + method.split('.').pop().substring(3).toLowerCase() : method.split('.').pop().toLowerCase()})`
+    const linkify = (method) => `[${method}](./lifecycle-manager/${method.split('.').shift()}/#${method.match(/\.on[A-Z]/) ? method.split('.').pop().charAt(2).toLowerCase() + method.split('.').pop().substring(3).toLowerCase() : method.split('.').pop().toLowerCase()})`
     Object.keys(capabilities).sort().forEach(c => {
         manifest += `### \`${c}\`\n`
 

src/js/github.io/index.mjs

@@ -159,9 +159,9 @@ const run = async (version, parsedArgs) => {
             const v = `${legacy}.x`
 
             // create a temporary npm package and install the version of Firebolt we want to grab
-            await exec(`cd build; mkdir temp${legacy}; cd temp${legacy}; npm init -y ; npm install --saveDev @firebolt-extn-js/ripple-sdk@${v}`)
+            await exec(`cd build; mkdir temp${legacy}; cd temp${legacy}; npm init -y ; npm install --saveDev @firebolt-js/lifecycle-manager@${v}`)
 
-            version.apis[`${legacy}`] = await loadJson(`./build/temp${legacy}/node_modules/@firebolt-extn-js/ripple-sdk/dist/firebolt-open-rpc.json`)
+            version.apis[`${legacy}`] = await loadJson(`./build/temp${legacy}/node_modules/@firebolt-js/lifecycle-manager/dist/firebolt-open-rpc.json`)
             await exec(`cd build; rm -r temp${legacy}`)
 
             logSuccess(`Added version ${v}`)

src/js/version-specification/apis.mjs

@@ -81,7 +81,7 @@ else if (task === 'validate') {
     console.log('Finding the latest prerelease')
     const prerelease = process.argv.shift()
     console.log('prerelease : ' + prerelease)
-    exec("npm show @firebolt-extn-js/ripple-sdk versions --json", (error, result, errlog) => {
+    exec("npm show @firebolt-js/lifecycle-manager versions --json", (error, result, errlog) => {
         if (error) {
             console.error(`error: ${error.message}`);
             return;

src/js/version.mjs

@@ -3,7 +3,7 @@
     "major": 1,
     "minor": 0,
     "patch": 0,
-    "readable": "Ripple SDK"
+    "readable": "Lifecycle Manager"
   },
   "capabilities": {
   },