Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 2.16 KB

README.md

File metadata and controls

81 lines (58 loc) · 2.16 KB

sunbird-telemetry-service

This is the repository for Sunbird telemetry microservice. It provides APIs for Sunbird telemetry.

The code in this repository is licensed under MIT License unless otherwise noted. Please see the LICENSE file for details.

Development Setup

Prerequisites

  • Node.js v22.15
  • Kafka

Local Development

To set up the project locally:

  1. Fork the repository on GitHub

  2. Clone your fork:

git clone https://github.com/your-username/sunbird-telemetry-service.git
cd sunbird-telemetry-service
cd src
  1. Install dependencies:
npm i
  1. Start the service:
npm run start
  1. Run Kafka and Zookeeper

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-telemetry-service:v1.0.0_abc123_1