Merge pull request #59 from yashashkumar/actions

Actions

Author: manjudr

.github/workflows/npm-publish.yml

@@ -0,0 +1,54 @@
+name: Publish Release Telemetry SDK
+
+on:
+  push:
+    tags:
+      - '*'
+    
+jobs:
+  # Build and publish to npm registry
+  build-and-publish:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: js
+    steps:
+      # Step 1: Checkout the source code from the tag
+      - uses: actions/checkout@v3
+
+      # Step 2: Set up Node.js environment for building
+      # Uses Node.js 16 which is stable and well-supported
+      - name: Set up Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+          cache: 'npm'
+          cache-dependency-path: 'js/package-lock.json'
+          registry-url: 'https://registry.npmjs.org'
+          always-auth: true
+
+      # Step 3: Cache npm dependencies to speed up builds
+      # This caches the node_modules directory between workflow runs
+      - name: Cache npm packages
+        id: cache-npm
+        uses: actions/cache@v3
+        with:
+          path: js/node_modules
+          key: ${{ runner.os }}-npm-${{ hashFiles('js/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-npm-
+
+      # Step 4: Install dependencies
+      - name: Install dependencies
+        run: npm install
+
+      # Step 5: Build the SDK
+      # This creates the bundled telemetry SDK in the dist directory
+      - name: Build Telemetry SDK
+        run: npm run build
+
+      # Step 7: Publish to npm registry
+      - name: Publish to npm
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm publish --access public

.github/workflows/pull-request.yml

@@ -0,0 +1,57 @@
+name: Build, Test and Lint
+
+on:
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  build-test-sonar:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: js
+
+      - name: Build
+        run: npm run build
+        working-directory: js
+
+      - name: Run tests
+        run: npm test
+        working-directory: js
+        continue-on-error: true
+
+      #- name: Install SonarQube scanner
+       # run: npm install -g sonarqube-scanner
+
+      #- name: Run SonarQube scanner
+       # env:
+        #  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+         # SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        #run: sonar-scanner
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install dependencies
+        run: npm install
+        working-directory: js
+
+      - name: Run ESLint
+        run: npm run lint
+        working-directory: js 

js/.eslintrc.js

@@ -0,0 +1,22 @@
+require('eslint-plugin-only-warn');
+
+module.exports = {
+  plugins: ['only-warn'],
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+    jasmine: true
+  },
+  extends: [
+    'eslint:recommended'
+  ],
+  parserOptions: {
+    ecmaVersion: 12,
+    sourceType: 'module'
+  },
+  rules: {
+    'no-unused-vars': 'warn',
+    'no-console': 'off'
+  }
+};

js/README.md

@@ -910,6 +910,32 @@ let data = { // Required
   * Travis integration     
 
 
-  
+# GitHub Actions
+
+## Build and Test on Pull Request
+
+This GitHub Actions workflow runs **build, test, and lint checks** automatically when a pull request is opened against any branch.
+
+### When It Runs
+
+- **Trigger**: On every `pull_request` to any branch (`'**'`)
+
+### Prerequisites Before Triggering
+
+Make sure the following are set up **before** opening a pull request:
+
+### Secrets
+`SONAR_TOKEN`: For SonarQube authentication 
+
+## NPM Publish Github action
+
+### When It Runs
+
+- **Trigger**: On every tag creation from any branch (`'*'`)
+
+### Prerequisites
+
+Make sure that `NPM_TOKEN` is set in Secrets before creating a tag.
 
+Note: The secrets and variables should be set in Github UI (`settings/secrets and variables/actions`)
 

js/package.json

@@ -23,13 +23,16 @@
         "karma-ng-html2js-preprocessor": "1.0.0",
         "karma-phantomjs-launcher": "^1.0.4",
         "karma-verbose-reporter": "0.0.6",
-        "rimraf": "2.6.2"
+        "rimraf": "2.6.2",
+        "eslint": "^8.57.0",
+        "eslint-plugin-only-warn": "^1.0.4"
     },
     "scripts": {
         "test": "karma start karma.renderer.config.js",
         "codecov": "codecov",
         "test-sdk": "karma start karma.renderer.config.js",
-        "build": "node_modules/.bin/rimraf ./dist && node bundle-schema.js && node buildSDK.js && node_modules/.bin/cpy package.json ./dist && node_modules/.bin/cpy README.md ./dist"
+        "build": "node_modules/.bin/rimraf ./dist && node bundle-schema.js && node buildSDK.js && node_modules/.bin/cpy package.json ./dist && node_modules/.bin/cpy README.md ./dist",
+        "lint": "eslint . --ext .js"
     },
     "repository": {
         "type": "git",

sonar-project.properties

@@ -0,0 +1,7 @@
+#sonar.projectName=sunbird-telemetry-sdk
+#sonar.language=js
+#sonar.sources=.
+#sonar.projectKey=project-sunbird_sunbird-telemetry-sdk
+#sonar.host.url=https://sonarcloud.io
+#sonar.organization=project-sunbird
+#sonar.projectVersion=1.0