Ef'Réussite PEX Webhooks

📜 Les annonces du discord Ef'Réussite PEx !

🆕 Ajouter un message

1. Créez une nouvelle branche avec le titre du message.

2. Ajouter un fichier markdown dans ./resources. Choisissez un des sous-dossiers qui correspond à votre message.

   • guide pour les messages du guide (#📍-guide-et-liens)
   • rules pour les messages des règles (#📜-règles)
   • bachelor pour les annonces pour les Bachelors et BTS (#🔵-annonces-bachelor)
   • master pour les annonces pour les MSc et Mastères (#🟣-annonces-master)
   • global pour les annonces générales (#📢-annonces)
   • poll pour les messages de sondage (#🤔-sondages)
   • tips pour les annonces "bon à savoir" (#📢-bon-à-savoir-❗)

   À part pour guide et rules, il vous faudra choisir un deuxième sous-dossier correspondant à l'année scolaire en cours. Par exemple, bachelor/2022-2023/. Le nom du fichier en lui même doit être une courte description de l'annonce (avec ou sans espaces, accents, majuscules, caractères spéciaux...), seuls les points (.), et les slashs/anti-slashs (/ et \) ne sont pas autorisés.

   Si le dossier dans lequel vous devez mettre votre annonce contient un fichier .gitkeep, vous pouvez le supprimer.

3. Faites une Pull Request de votre branche vers master, pour que tout le monde puisse la review.

💡 Astuces pour un message bien formatté

• Chaque paragraphe séparé par ===MESSAGE_BREAK=== sera posté dans un nouveau message. Essayez d'utiliser le moins de messages possible (la limite est de 2000 caractères par message) pour éviter les rate limits.

• Utilisez "nous", "l'équipe" etc, pas "je" car les lecteurs ne sauront pas de qui vous parlez comme le message sera posté sous le nom "Horizon".

• Pensez à utilisez des émojis !

• Intégrez les liens au texte, par exemple [Rendez-vous sur Google](https://www.google.com) qui donne "Rendez-vous sur Google". Évitez de mettre un lien uniquement sur des textes cours et non descriptifs ("Cliquez [ici]", "Vous pouvez le voir [là]"...).

• Utilisez du gras (**gras**), de l'italique (*italique*) et du souligné (__souligné__) pour mettre en forme votre texte.

• Utilisez des images ! Pour cela, il faut :

  1. Créez un ou des dossier(s) dans ./resources/_images/ correspondants aux dossiers dans lesquels vous avez mis votre annonce. Exemples :
     • Pour une annonce dans ./resources/guide/Premier message.md, il faut créer le dossier ./resources/_images/guide/Premier message/
     • Pour une annonce dans ./resources/bachelor/2021-2022/Ateliers mobilité S5.md, il faut créer le dossier ./resources/_images/bachelor/2021-2022/Ateliers mobilité S5/ Notez bien qu'il faut créer un dossier correspondant au nom de votre annonce, mais sans le .md à la fin.
  2. Dans ./resources/_images/<FOLDER_NAME>, ajoutez l'image au format .png avec un nom tout en MAJUSCULES avec uniquement des lettres, des chiffres et des underscores (_).
  3. Les référencer dans le fichier markdown avec %PNG_<IMAGE_FILE_NAME>%.

  Les images apparaitront toujours à la fin du message, sauf si vous utilisez ===MESSAGE_BREAK===.

🚀 Déployer un message

Une fois qu'un document est prêt à être publié, il peut être déployé avec le workflow GitHub.

1. Allez sur le workflow GitHub de déploiement ou de pré-déploiement pour tester d'abord.
2. Cliquez sur "Run workflow".
3. Dans le champs d'input, mettez le nom du fichier à déployer avec ses dossiers parents, sauf le dossier resource. Exemple : guide/Premier message.md ou bachelor/2021-2022/Ateliers mobilité S5 (le .md est facultatif).
4. Confirmez en cliquant sur "Run workflow".

✏️ Mise à jour d'un message

La mise à jour d'un message se fait manuellement. Installez le projet en local avec git clone https://github.com/horizon-efrei/efreussite-pex-webhooks && cd efreussite-pex-webhooks && npm install. Si la commande npm n'est pas reconnue, vous devez installer Node.js. Assurez-vous d'avoir Node.js ≥16.9.0 minimum, via node -v. Autrement, mettez-le à jour. Ensuite, dans le fichier updater, suivez les instructions en commentaire. Remplacez le contenu du message, l'ID du message et l'url du webhook comme indiqué.

Enfin, dans votre terminal entrez npm run update pour lancer la mise à jour. Pensez à ne pas commit vos modifications.

Crédits

Dérivé du système de webhooks de Sapphire : https://github.com/sapphiredev/resource-webhooks