Release 8.1.0

.github/workflows/on_push.yml

@@ -0,0 +1,44 @@
+name: Create Tag on Push
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with: 
+          node-version: '22.15'
+
+      - name: Check installed versions
+        run: |
+          node -v
+
+      - name: Install dependencies
+        run: |
+          npm install
+
+      - name: Install webpack
+        run: npm install --save-dev webpack webpack-cli
+
+      - name: Build and Pack
+        run: |
+          npm run build:prod 
+          npm pack ./dist
+
+      - name: Publish to NPM
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}" > ~/.npmrc
+          npm publish project-sunbird-client-services-*
+
+

.github/workflows/pull_request.yml

@@ -0,0 +1,61 @@
+name: PR Build
+
+on:
+  pull_request:
+
+jobs:
+  build-pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with: 
+          node-version: '22.15'
+
+      - name: Check installed versions
+        run: |
+          node -v
+
+      - name: Restore node_modules cache
+        id: cache
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-modules-
+
+      - name: Install dependencies
+        run: |
+          npm i 
+
+      - name: Save node_modules cache
+        if: steps.cache.outputs.cache-hit != 'true'
+        uses: actions/cache@v3
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('**/package-lock.json') }}
+
+      - name: Install webpack
+        run: npm install --save-dev webpack webpack-cli
+
+      - name: Install SonarQube scanner
+        run: npm install -g sonarqube-scanner
+
+      - name: Run SonarScanner
+        run: sonar-scanner    
+
+      - name: Build project and Pack (PR)
+        run: |
+          npm run build:prod
+          npm pack ./dist
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run tests with coverage
+        run: npm run test:ci

README.md

@@ -2,6 +2,8 @@
 
 ## Table of Contents
 
+1. [Development](#development-setup)
+1. [Continuous Integration](#continuous-integration)
 1. [Overview](#overview)
 1. [Installation](#installation)
 1. [Getting Started](#getting-started)
@@ -10,6 +12,73 @@
 1. [Services](#services)
    1. [CsGroupService](#csgroupservice)
 
+## Development setup
+
+### Prerequisites
+
+NodeJS 22.15
+
+### Local Development
+
+1. Fork the repository on GitHub
+
+2. Clone your fork:
+
+``` 
+ git clone https://github.com/your-username/sunbird-client-service.git
+
+cd sunbird-client-service
+```
+3. Install dependencies:
+
+```
+npm i
+```
+4. To run the project
+```
+npm run build
+```
+## Continuous Integration
+
+This project uses GitHub Actions for automated testing, building, and publishing. Below are details of the CI processes:
+
+### Pull Request Workflow
+
+When a pull request is opened or updated, the following automated checks are performed:
+
+1. **Code checkout**: The repository code is checked out
+2. **Environment setup**: Node.js 22.15 is installed and configured
+4. **Test execution**: All tests are run with coverage reporting
+5. **Code linting**: ESLint is run to check code style and quality
+6. **Static code analysis**: SonarQube scan is performed to evaluate code quality
+6. **Build verification**: The project is built using webpack to ensure it compiles correctly. Ensure ```SONAR_TOKEN``` is configured in your repository.
+
+This ensures that all changes in pull requests meet quality standards before merging.
+
+### Release Workflow
+
+When a new tag is pushed to the repository, the following automated steps are executed:
+
+1. **Code checkout**: The tagged version of code is checked out
+2. **Environment setup**: Node.js 22.15 is installed and configured with NPM registry access
+3. **Dependency installation**: Project dependencies are installed via `npm i`
+4. **Build process**: The project is built for production
+5. **Package creation**: The build output is packaged for distribution
+6. **NPM publication**: The package is published to the NPM registry after setting ```NPM_TOKEN```
+
+This allows for simple, reliable releases by simply pushing a new tag.
+
+### Manual Release Process
+
+To manually trigger a new release:
+
+1. Update the version in `package.json`
+2. Commit the change: `git commit -m "Increase version to x.y.z"`
+3. Create and push a tag: `git tag v{x.y.z} && git push origin v{x.y.z}`
+
+The GitHub Actions workflow will automatically build and publish the new version.
+
+
 ## Overview
 
 The library is grouped into Modules and SubModules as shown below -
@@ -258,4 +327,4 @@ CsModule.instance.init({
 export interface CsCourseService {
     getUserEnrollmentList(request: GetUserEnrollmentListRequests, additionalParams?: { [key: string]: string }, config?: CsCourseServiceConfig): Observable<Course[]>;
 }
-```
+```