Merge pull request #5 from Deeksha1502/test_github_actions

SBCOSS-403: Added GitHub Actions to Sunbird Echo Service

Author: HarishGangula

.eslintignore

@@ -0,0 +1 @@
+/node_modules

.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  env: {
+    node: true,
+    es2021: true
+  },
+  parserOptions: {
+    ecmaVersion: 'latest'
+  },
+  rules: {
+    'no-console': 'warn',
+    'no-debugger': 'error',
+    'no-unused-vars': 'warn',
+    'semi': ['error', 'always'],
+    'quotes': ['error', 'single'],
+    'indent': ['error', 2]
+      
+  }
+};

README.md

@@ -5,4 +5,71 @@ This is an echo service that will listen on 9595 and return a 200 OK
 
 The PARALLELISM variable defaults to 2. Set an environment variable with the same name to change parallelism.
 
-To build the docker image, execute docker build --tag echoservice:0.0.1 .
+To build the docker image, execute docker build --tag echoservice:0.0.1 .
+
+## Development Setup
+
+### Prerequisites
+- Node.js v22.15
+
+### Local Development
+To set up the project locally:
+
+1. Fork the repository on GitHub
+
+2. Clone your fork:
+```bash
+git clone https://github.com/your-username/sunbird-echo-service.git
+cd sunbird-echo-service
+```
+
+3. Install dependencies:
+```bash
+npm i
+```
+
+### Code Quality
+
+The project maintains code quality through automated checks that run on every pull request:
+
+1. **Linting**
+   - ESLint for code style and quality
+   - Command: `npm run lint`
+
+2. **Dependencies**
+   - Uses `npm ci` for deterministic installations
+   - GitHub Actions cache for faster builds
+
+3. **Code Formatting**
+   - Ensures consistent code formatting
+   - Can be automatically fixed using `npm run lint:fix`
+
+These checks ensure consistent code style and secure dependency management.
+
+## Container Image Publishing
+
+This repository uses GitHub Actions to automatically build and publish Docker container images to GitHub Container Registry (GHCR) whenever a new tag is pushed to the repository.
+
+### Build and Publish Workflow
+
+The workflow is triggered on:
+- creation of any tag
+
+Key features of the workflow:
+1. Automatically builds Docker images
+2. Tags images with a combination of:
+   - The tag name (lowercased)
+   - Short commit hash
+   - GitHub run number
+3. Publishes images to `ghcr.io` using the repository name
+4. Uses GitHub Actions for secure authentication to GHCR
+
+### Image Naming Convention
+The Docker images follow this naming convention:
+- Repository: `ghcr.io/${OWNER_NAME}/${REPO_NAME_LOWERCASE}`
+- Tag: `${TAG_NAME}_${COMMIT_HASH}_${RUN_NUMBER}`
+
+For example, if you push a tag `v1.0.0` on commit `abc123`, the resulting image would be:
+```
+ghcr.io/project-sunbird/sunbird-echo-service:v1.0.0_abc123_1
+```

index.js

@@ -2,43 +2,43 @@ const cluster = require('cluster');
 
 if (cluster.isMaster) {
 
-    // Parallelism can be configured through env params
-    var cpuCount = process.env.PARALLELISM || 2;
+  // Parallelism can be configured through env params
+  var cpuCount = process.env.PARALLELISM || 2;
 
-    // Create a worker for each CPU
-    for (var i = 0; i < cpuCount; i += 1) {
-        cluster.fork();
-    }
+  // Create a worker for each CPU
+  for (var i = 0; i < cpuCount; i += 1) {
+    cluster.fork();
+  }
 } else {
-    const express = require("express");
-    const app = express();
-    const port = 9595
-
-    var server = app.listen(port, () => {
-        console.log("Server running on port " + port);
-    });
-
-    server.on('connection', function(socket) {
-        //Below line has been added to check how many new connections are being made. This should be very few in a keep alive env
-        console.log("New connection was made by client");
-        socket.setTimeout(180 * 1000); 
-    });
-
-    app.get("/", (req, res, next) => {
-        res.status(200).send('hello');
-    });
-
-    app.get("/:reqpath", (req, res, next) => {
-        let reqpath = req.params.reqpath;
-        res.status(200).send(reqpath);
-    });
-
-    app.get("/service/health", (req, res, next) => {
-        res.status(200).send('{"healthy":true}');
-    });
-
-    app.use(function (req,res,next){
-        res.status(200).send('Unknown Path');
-    });
+  const express = require('express');
+  const app = express();
+  const port = 9595;
+
+  var server = app.listen(port, () => {
+    console.log('Server running on port ' + port);
+  });
+
+  server.on('connection', function(socket) {
+    //Below line has been added to check how many new connections are being made. This should be very few in a keep alive env
+    console.log('New connection was made by client');
+    socket.setTimeout(180 * 1000); 
+  });
+
+  app.get('/', (req, res, next) => {
+    res.status(200).send('hello');
+  });
+
+  app.get('/:reqpath', (req, res, next) => {
+    let reqpath = req.params.reqpath;
+    res.status(200).send(reqpath);
+  });
+
+  app.get('/service/health', (req, res, next) => {
+    res.status(200).send('{"healthy":true}');
+  });
+
+  app.use(function (req,res,next){
+    res.status(200).send('Unknown Path');
+  });
 
 }