CI/CD Pipeline - R-Type Project by Master KALAMBO DANIEL

Ce document décrit le pipeline CI/CD complet du projet R-Type utilisant GitHub Actions.

Vue d'ensemble

Le pipeline se compose de 3 jobs principaux :

Build & Test : Compilation et tests unitaires
Docker Build & Push : Création et publication des images Docker
Notify : Notifications de statut

🔄 Workflow

┌─────────────┐
│   Push/PR   │
└──────┬──────┘
       │
       ▼
┌─────────────────────────┐
│  Build & Test (Ubuntu)  │
│  - Install dependencies │
│  - Compile with CMake   │
│  - Run tests           │
│  - Upload artifacts     │
└──────────┬──────────────┘
           │ (success)
           ▼
┌─────────────────────────┐
│  Docker Build & Push    │
│  - Download artifacts   │
│  - Build Server image   │
│  - Build Client image   │
│  - Push to GHCR        │
└──────────┬──────────────┘
           │
           ▼
┌─────────────────────────┐
│     Notifications       │
│  - Summary report       │
│  - Status badges        │
└─────────────────────────┘

┌─────────────┐
│   Push/PR   │
└──────┬──────┘
       │
       ▼
┌─────────────────────────┐
│  Build & Test (Ubuntu)  │
│  - Install dependencies │
│  - Compile with CMake   │
│  - Run tests           │
│  - Upload artifacts     │
└──────────┬──────────────┘
           │ (success)
           ▼
┌─────────────────────────┐
│  Docker Build & Push    │
│  - Download artifacts   │
│  - Build Server image   │
│  - Build Client image   │
│  - Push to GHCR        │
└──────────┬──────────────┘
           │
           ▼
┌─────────────────────────┐
│     Notifications       │
│  - Summary report       │
│  - Status badges        │
└─────────────────────────┘

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

Déclenchement

Le pipeline se déclenche automatiquement sur :

✅ Push sur les branches : main, dev, develop
✅ Pull Request vers main
✅ Déclenchement manuel via l'interface GitHub Actions

Job 1 : Build & Test

Environnement

OS : Ubuntu 22.04
Compiler : g++ (C++17)
Build System : CMake + Ninja
Package Manager : Conan 2.0

Étapes détaillées

Checkout du code

yaml

- uses: actions/checkout@v4

- uses: actions/checkout@v4

Installation des dépendances système
- CMake, g++, Ninja
- Bibliothèques SFML (OpenGL, X11, etc.)
- Boost libraries

Configuration Conan

bash

pip3 install conan==2.0.17
conan profile detect
conan install .. --build=missing

pip3 install conan==2.0.17
conan profile detect
conan install .. --build=missing

1
2
3

Compilation CMake

bash

cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j $(nproc)

cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j $(nproc)

1
2

Vérification des binaires
- r-type_server
- r-type_client
- rtype_game
- Plugins .so dans LibEngine/Systems/
Upload des artifacts
- Binaires compilés
- Assets
- Plugins
- Rétention : 7 jours

Artifacts produits

rtype-binaries-{SHA}/
├── r-type_server
├── r-type_client
├── rtype_game
├── LibEngine/Systems/*.so
└── Assets/**/*

rtype-binaries-{SHA}/
├── r-type_server
├── r-type_client
├── rtype_game
├── LibEngine/Systems/*.so
└── Assets/**/*

1
2
3
4
5
6

Job 2 : Docker Build & Push

Condition : Succès du Job 1 + Push sur main ou dev

Images créées

Image Serveur

Base : Ubuntu 22.04
Taille : ~200 MB
Port : 4242, 8080
Registry : ghcr.io/{owner}/{repo}/rtype-server
Tags :
- latest (sur main)
- {branch} (nom de la branche)
- {branch}-{sha} (commit hash)

Image Client

Base : Ubuntu 22.04 + SFML
Taille : ~300 MB
Display : X11 forwarding requis
Registry : ghcr.io/{owner}/{repo}/rtype-client
Tags : (identiques au serveur)

Processus de build

mermaid

graph LR
    A[Download Artifacts] --> B[Prepare Files]
    B --> C[Build Server Image]
    B --> D[Build Client Image]
    C --> E[Push to GHCR]
    D --> E

graph LR
    A[Download Artifacts] --> B[Prepare Files]
    B --> C[Build Server Image]
    B --> D[Build Client Image]
    C --> E[Push to GHCR]
    D --> E

1
2
3
4
5
6

Authentication

Le pipeline utilise automatiquement GITHUB_TOKEN pour :

✅ Pull/Push vers GitHub Container Registry
✅ Permissions : contents:read, packages:write

Job 3 : Notifications

Ce job s'exécute toujours (même en cas d'échec) et :

✅ Affiche le statut du build
✅ Affiche le statut du déploiement Docker
✅ Génère un résumé dans GitHub Actions
❌ Échoue si le build a échoué

Utilisation

Développement local

bash

# Compiler localement
mkdir build && cd build
conan install .. --build=missing
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build . -j

# Tester
./r-type_server --help
./r-type_client --help

# Compiler localement
mkdir build && cd build
conan install .. --build=missing
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build . -j

# Tester
./r-type_server --help
./r-type_client --help

1
2
3
4
5
6
7
8
9

Déclencher le pipeline

bash

# Méthode 1 : Push sur une branche surveillée
git add .
git commit -m "feat: nouvelle fonctionnalité"
git push origin main

# Méthode 2 : Via l'interface GitHub
# Actions > CI/CD Pipeline > Run workflow

# Méthode 1 : Push sur une branche surveillée
git add .
git commit -m "feat: nouvelle fonctionnalité"
git push origin main

# Méthode 2 : Via l'interface GitHub
# Actions > CI/CD Pipeline > Run workflow

1
2
3
4
5
6
7

Utiliser les images Docker

bash

# Pull depuis GitHub Container Registry
docker pull ghcr.io/epitechpge3-2025/g-cpp-500-cot-5-1-rtype-2/rtype-server:latest

# Lancer le serveur
docker run -d -p 4242:4242 \
  ghcr.io/epitechpge3-2025/g-cpp-500-cot-5-1-rtype-2/rtype-server:latest

# Pull depuis GitHub Container Registry
docker pull ghcr.io/epitechpge3-2025/g-cpp-500-cot-5-1-rtype-2/rtype-server:latest

# Lancer le serveur
docker run -d -p 4242:4242 \
  ghcr.io/epitechpge3-2025/g-cpp-500-cot-5-1-rtype-2/rtype-server:latest

1
2
3
4
5
6

Monitoring

Via GitHub Actions UI

Accédez à Actions dans le repository
Sélectionnez le workflow "R-Type CI/CD Pipeline"
Visualisez :
- Status de chaque job
- Temps d'exécution
- Artifacts disponibles
- Logs détaillés

Badges de statut

Ajoutez ces badges dans votre README :

markdown

![CI/CD](https://github.com/EpitechPGE3-2025/G-CPP-500-COT-5-1-rtype-2/actions/workflows/build.yaml/badge.svg)

![CI/CD](https://github.com/EpitechPGE3-2025/G-CPP-500-COT-5-1-rtype-2/actions/workflows/build.yaml/badge.svg)

Consulter les images Docker

bash

# Lister les tags disponibles
docker image ls | grep rtype

# Inspecter une image
docker inspect ghcr.io/epitechpge3-2025/g-cpp-500-cot-5-1-rtype-2/rtype-server:latest

# Lister les tags disponibles
docker image ls | grep rtype

# Inspecter une image
docker inspect ghcr.io/epitechpge3-2025/g-cpp-500-cot-5-1-rtype-2/rtype-server:latest

1
2
3
4
5

🔧 Configuration

Variables d'environnement

Définies dans .github/workflows/build.yaml :

yaml

env:
  BUILD_TYPE: Release
  CONAN_VERSION: 2.0.17

env:
  BUILD_TYPE: Release
  CONAN_VERSION: 2.0.17

1
2
3

Secrets requis

GITHUB_TOKEN : Fourni automatiquement par GitHub Actions

Permissions

Le workflow nécessite :

yaml

permissions:
  contents: read    # Lire le code
  packages: write   # Publier les images Docker

permissions:
  contents: read    # Lire le code
  packages: write   # Publier les images Docker

1
2
3

📚 Fichiers du pipeline

.github/workflows/
└── build.yaml                 # Pipeline principal

docker/
├── Dockerfile.server          # Image serveur
├── Dockerfile.client          # Image client
├── docker-compose.yml         # Orchestration
└── README.md                  # Documentation Docker

.dockerignore                  # Exclusions Docker

.github/workflows/
└── build.yaml                 # Pipeline principal

docker/
├── Dockerfile.server          # Image serveur
├── Dockerfile.client          # Image client
├── docker-compose.yml         # Orchestration
└── README.md                  # Documentation Docker

.dockerignore                  # Exclusions Docker

1
2
3
4
5
6
7
8
9
10

Avantages :

Builds plus rapides (2-3x)
Réduction du temps de build
Réutilisation des layers Docker

Build parallèle

yaml

cmake --build build -j $(nproc)

cmake --build build -j $(nproc)

Utilise tous les cœurs CPU disponibles.

Artifacts retention

yaml

retention-days: 7

retention-days: 7

Les artifacts sont conservés 7 jours pour économiser l'espace.

🔗 Liens utiles

📧 Support

En cas de problème :

Consultez les logs GitHub Actions
Vérifiez la documentation Docker
Ouvrez une issue sur GitHub

CI/CD Pipeline - R-Type Project by Master KALAMBO DANIEL #

Vue d'ensemble #

🔄 Workflow #

Déclenchement #

Job 1 : Build & Test #

Environnement #

Étapes détaillées #

Artifacts produits #

Job 2 : Docker Build & Push #

Images créées #

Image Serveur #

Image Client #

Processus de build #

Authentication #

Job 3 : Notifications #

Utilisation #

Développement local #

Déclencher le pipeline #

Utiliser les images Docker #

Monitoring #

Via GitHub Actions UI #

Badges de statut #

Consulter les images Docker #

🔧 Configuration #

Variables d'environnement #

Secrets requis #

Permissions #

📚 Fichiers du pipeline #

Build parallèle #

Artifacts retention #

🔗 Liens utiles #

📧 Support #

CI/CD Pipeline - R-Type Project by Master KALAMBO DANIEL

Vue d'ensemble

🔄 Workflow

Déclenchement

Job 1 : Build & Test

Environnement

Étapes détaillées

Artifacts produits

Job 2 : Docker Build & Push

Images créées

Image Serveur

Image Client

Processus de build

Authentication

Job 3 : Notifications

Utilisation

Développement local

Déclencher le pipeline

Utiliser les images Docker

Monitoring

Via GitHub Actions UI

Badges de statut

Consulter les images Docker

🔧 Configuration

Variables d'environnement

Secrets requis

Permissions

📚 Fichiers du pipeline

Build parallèle

Artifacts retention

🔗 Liens utiles

📧 Support