CI Documentation

1. Webhook Listener

POST /webhook

This endpoint listens for GitHub push events and triggers the following actions:

• Check out the triggered branch
• Pull the latest changes
• Run a static syntax check using Flake8
• Execute tests using pytest

Returns: A JSON response with syntax check and test results.

2. Compilation Process

The compilation.py module handles the compilation process for a given branch:

• Checks out the specified branch
• Pulls the latest changes
• Runs Flake8 for static analysis

Returns: Compilation logs and results.

3. Test Execution

The testing.py module runs tests using pytest:

• Executes all tests in the specified directory
• Captures test results and logs

Returns: A report of test results.

4. Send Email Notification

POST /send-notification

Sends an email notification after a CI build event with details such as author, branch, commit, and build status.

Parameters:

• author: Commit author (required)
• branch: Branch name (required)
• commit: Commit ID (required)
• status: Build status (success/failure) (required)

Returns: Confirmation of email sent or an error message.