Merge pull request #8 from GomuDevelopers/dev

pull request for merging all modifications  on dev branch

Readme.md

@@ -1,18 +1,43 @@
-# GomuDevelopers workflow template 🚀
+# Gomu Gomu Developpeur - Workflow Template 🚀
 
-Community Core Project
+Bienvenue sur le dépôt du bot du channel Gomu Gomu Developpeur !
 
-  This project consist of creating a workflow to that aim is to be reused on several other different projects as a template **🛠️**.  Before continuing let's clairify 
-  some points for newbies .
-- **Workflow** refers to a series of automated steps or tasks that are executed in response to specific events or triggers within a software development project ⚙️.
-    It is a configurable set of actions defined in a YAML file, which allows developers to automate various aspects of their workflow, such as building, testing, deploying, and releasing code.
+Ce dépôt héberge le code source du workflow et du  bot qui alimente le channel Telegram de l'organisation Gomu Gomu Developpeur. Ansi nous pourrons le réutilisé dans d'autre projet différent .
 
- > As  you may have guess , here we are creating a workflow template that we shall custom to for different of other projects , it will be usefull in case we want to trigger specific
- > events like folks, pull request , builds . Moreover , on automation task like `constinous intergration` , `continous delivery` and  `testing` .
+Le bot est conçu pour vous tenir informé de toute l'activité sur le dépôt principal de l'organisation. Il surveille les actions effectuées par les membres et vous envoie des notifications en temps réel via Telegram.
 
-   [Link to official documentation](https://docs.github.com/fr/actions/learn-github-actions)
+## Fonctionnalités du bot
 
-   Don't hesitate if you want to know more
-
+- Détection des commits et pushs : Le bot identifie chaque commit et push effectué sur le dépôt principal et envoie un message d'information sur le channel Telegram.
+- Suivi des Pull Requests : Le bot détecte la création de nouvelles Pull Requests et informe le channel Telegram pour une meilleure collaboration.
+
+## Prérequis
+
+Pour exécuter le bot, vous aurez besoin de :
 
-
+- Un compte GitHub
+- Un bot Telegram créé pour interagir avec le channel. (Plusieurs services en ligne permettent de créer des bots Telegram.)
+- Un channel Telegram pour intéragir avec le bot dans notre cas notre nos l'avons configuré  pour la communauté Gomu Gomu Developpeur .
+- Python
+
+## Installation
+
+1. Cloner le dépôt:
+   ```bash
+   git clone https://github.com/GomuDevelopers/workflow_template.git
+   ```
+2. Configuration du bot
+    Créez un fichier nommé .env dans la racine du projet ou allez créé des variable secret et renseignez les variables d'environnement suivantes :
+   ```bash
+     BOT_TOKEN=YOUR_BOT_TOKEN
+     TELEGRAM_CHAT_ID=YOUR_TELEGRAM_CHAT_ID
+   ```
+
+    **Remplacez les valeurs suivantes**
+    - `YOUR_BOT_TOKEN`: Le token d'accès de votre bot Telegram.
+    - `YOUR_TELEGRAM_CHAT_ID`: L'identifiant unique de votre channel Telegram.
+
+## Contribuer au projet
+  Nous encourageons les contributions à ce projet ! N'hésitez pas à créer des issues pour signaler des bugs ou proposer des améliorations.  Vous pouvez également 
+  soumettre des Pull Requests pour intégrer vos modifications au code source.
+

src/notify_on_pull_request.py

@@ -9,8 +9,9 @@ def send_msg_on_PR():
     title = os.environ['GITHUB_PR_TITLE']
     body = os.environ['GITHUB_PR_BODY']
 
+    repository = os.environ['GITHUB_REPOSITORY']
     date = time.ctime()
-    text = f"📌 Pull Request  effectué par {author} 🧠 \n Date: {date}  \n \n Title :{title}\n Comments: {body[:25]} ... \n sentez vous libre l'examiné  {link}"
+    text = f"📌 Pull Request  effectué par {author} 🧠 \n Date: {date}  \n Depôt: {repository} \n Title :{title}\n Comments: {body[:30]} ... \n sentez vous libre l'examiné  {link}"
     send_msg(text)
 
 

src/notify_on_push.py

@@ -10,7 +10,7 @@ def send_msg_on_push():
     commits = os.environ['GITHUB_COMMIT']
     # count = len(os.environ['GITHUB_PuSH_NUMBER'])
     date = time.ctime()
-    text = f"📌 Push effectué par {author} 🧠 \n Date: {date}  \n \n Commits: {commits[:25]} ... \n sentez vous libre l'examiné  {link}"
+    text = f"📌 Push effectué  par {author} 🧠 \n Date: {date}  \n Depôt: {repository} \n Commits: {commits[:30]} ... \n sentez vous libre l'examiné  {link}"
     send_msg(text)