CYCLOPT Communication Service

The Cyclopt Communication Service is a robust solution designed to streamline communication for development teams by automating message delivery to popular platforms. This service keeps teams informed about crucial updates, such as commits, security alerts, and code quality metrics, directly within their preferred chat tools.

Features

Supported Communication Platforms

• Discord
• Microsoft Teams
• Mattermost
• Slack
• Google Chat

Message Types

This service generates three primary types of messages:

1. Regular Commit Messages
   Each commit triggers a message containing key details, including the author, commit message, and a link to the commit.

2. SAST Messages
   These messages report vulnerabilities detected during static application security tests, enabling developers to respond swiftly to potential security risks.

3. Quality Messages
   Insights on code quality metrics are provided to assist teams in maintaining coding standards and ensuring the health of their projects.

Prerequisites

Ensure the following are installed:

• Node.js (version 16 or higher)
• npm

Getting Started

To set up the Cyclopt Communication Service, clone the repository and install the necessary dependencies. Configuration of environment variables is essential for proper operation. This includes setting up basic authentication and defining redirect URLs for generated messages.

Example Configuration

Authentication requires the following environment variables:

COMMUNICATION_SERVICE_USERNAME="my-username"
COMMUNICATION_SERVICE_PASSWORD="my-password"

Redirect URLs must be configured accordingly for the service to function effectively:

SERVER_URL="https://backend.example.com"
COMPANION_URL="https://companion.example.com"
CYCLOPT_SITE_DOCUMENTATION="https://cyclopt.com/docs/documentation/violations"

Running the App

After configuring the backend server, the service can be started with:

npm run dev

Testing

Ensure code quality and functionality by running the following tests:

• Lint tests:

npm test

• Build and preview the production version:

npm run build && npm run preview

The Cyclopt Communication Service enhances team collaboration by ensuring timely updates are delivered to the right channels, fostering efficiency in development workflows.