Skip to content

vavarier/install-discord-action

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

65 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Discord Ci issue

Discord Ci est un outil pour les projets EPITECH permettant de lancer une norminette et des tests fonctionnels sur n'importe quel projet déjà implémentés. Les résultats des tests fonctionnels et de la norminette sont envoyés sur Discord. Tous les tests fonctionnels sont effectués sur l'environnement de la moulinette EPITECH.

Sommaire

  1. Installation
    1. Créer un répo Github vide privé
    2. Cloner le repo
    3. Commencer l’installation
  2. Utilisation
  3. Output
    1. Flags et discord report
    2. Trace
  4. Crédits

Installation

1- Créer un répo Git Hub vide privé

Ce répo va permettre au programme d’effectuer différents Github actions et de passer le projet au peigne fin avec une norminette.

2- cloner le répo Git Hub de discord Ci

le plus optimal est de cloner le répo dans :

/home/[nom d'utilisateur]

3- Commencer l'Installation

3.1- exécuter l'installer dans le dossier cloner

pour cela rentrez dans le repo et effectuez cette commande :

./install.sh

3.2- renseigner la clef ssh de votre repo créé lors de l'étape 1

lorsque ce message apparaîtra :

=> PLS give an empty repository link

écrivez le lien ssh vers le repo créé lors de l'étape 1

exemple clef ssh :

git@github.com:[utilisateur name]/[project name].git

3.3- Créer un webhook

Pour que Discord Ci vous envoi les résultats de ses tests vous allez devoir créer un webhook dans le channel Discord où vous voulez votre récapitulatif.

Suivez ce lien pour créer un [webhook](https://support.discord.com/hc/fr/articles/228383668-Utiliser-les-Webhooks) dans Discord

3.3- Renseigner l'adresse du webhook

Coller le lien du webhook lorsque ce message sera affiché :

=> PLS give discord webhook link

Ecrivez le lien du webhook créer dans l'étape précédente.

voila vous avez installé et configuré Discord Ci

Utilisation

discordci

Affiche l'aide.

discordci update

Télécharge et installe la dernière version de Discord Ci

discordci web [webhook link]

Permet de changer le salon discord dans lequel Discord Ci envoi le compte rendu

discordci repo [Git Hub SSH link]

Permet de changer le répo Github utilisé par Discord Ci

discordci [path to the folder] [name of the project]

Permet de lancer une moulinette sur votre projet

discordci [path to the folder] norm

Permet de n'appliquer que la norme

Output

Flag et discord report

green_discord_report

issue

Tous les tests ont été passé et pas d'erreur de norme.

yellow_discord_report

issue

Les tests et la compilation ont été passé mais le projet contient des erreurs de normes.

orange_discord_report

issue

Il n'y a pas d'erreur de norme. Cepandant, il y a des tests qui ne sont pas passé.

red_discord_report

issue

Votre projet ne compile pas.

Trace

Le flag et le discord report viennent avec une trace sous le nom de trace.md. Cette trace permet de voir en profondeur les erreurs de normes, les erreurs de compilation ou bien les tests qui ont échoués.

Crédis

Conception / programmation

Valentin Dury : linkeding bage git hub bage mail

Valentin Nouri : git hub bage mail

Rédaction

Baptiste Leroyer : linkeding bage git hub bage mail

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •