Aller au contenu principal

Notifications

DocStatic utilise GitHub Actions pour envoyer des notifications de workflow. Des exemples de notifications de révision et de traduction sont inclus dans le dossier .github/workflows/. Une configuration dans GitHub est nécessaire pour les activer. Vous pouvez également les utiliser comme point de départ pour développer vos propres notifications personnalisées.

E-mail​

Les actions email-review.yml et email-translate.yml sont déclenchées lorsque les balises de révision ou de traduction sont définies sur un fichier Markdown dans la branche principale. Pour les utiliser, ajoutez ces secrets à votre référentiel :

  • SMTP_SERVER
  • SMTP_PORT
  • SMTP_USERNAME
  • SMTP_PASSWORD
  • NOTIFY_EMAIL_TO
  • NOTIFY_EMAIL_FROM

Vous pouvez obtenir ces informations auprès de votre fournisseur de messagerie électronique. Par exemple :

Slack​

Les actions slack-review.yml et slack-translate.yml utilisent les mêmes déclencheurs que les versions e-mail. Pour les utiliser, ajoutez votre URL webhook Slack en tant que secret nommé SLACK_WEBHOOK_URL. Pour plus d'informations, consultez la section Envoi de messages à l'aide de webhooks entrants dans la documentation Slack.

Teams​

Les actions teams-review.yml et teams-translate.yml fonctionnent comme les versions Slack. Microsoft va abandonner l'application Incoming Webhooks pour Teams à partir de décembre 2025, mais il n'existe actuellement aucune méthode GitHub publique pour envoyer des Adaptive Cards aux workflows. La solution consiste à utiliser curl :

- name: Envoyer une notification de test Teams
  run: |
    curl --ssl-no-revoke -X POST \
    --location ${{ secrets.MS_TEAMS_HTTP_POST_URL }} \
    --header 'Content-Type: application/json' \
    --data '{ \
      "type": "message", \
      "attachments": [{ \
        "contentType": "application/vnd.microsoft.card.adaptive", \
        "content": { \
          "$schema": "http://adaptivecards.io/schemas/adaptive-card.json", \
          "type": "AdaptiveCard", \
          "version": "1.3", \
          "body": [ { \
            "type": "TextBlock", \
            "text": "Ceci est une notification test provenant de GitHub Actions (Teams).", \
            "wrap": true }]}}]}'
  1. Dans Teams, accédez au canal auquel vous souhaitez envoyer des messages, cliquez sur les points de suspension (…) et sélectionnez Workflows.
  2. Cliquez sur Gérer.
  3. Cliquez sur Nouveau flux.
  4. Recherchez des modèles pour les webhooks et cliquez sur Envoyer des alertes webhook à un canal.
  5. (Facultatif) Modifiez le Nom du flux.
  6. Connectez-vous et cliquez sur Suivant.
  7. Sélectionnez une Équipe et un Canal dans les listes, puis cliquez sur Créer un flux.
  8. Copiez la valeur MS_TEAMS_HTTP_POST_URL, enregistrez-la en tant que secret dans GitHub, puis cliquez sur Terminé.
Conseil

Vous pouvez utiliser l'action GitHub Test notifications pour tester vos connexions.