Aller au contenu principal

Notifications

DocStatic utilise GitHub Actions pour envoyer des notifications de flux de travail. 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.

Email​

Les actions email-review.yml et email-translate.yml sont déclenchées lorsque les balises review ou translate sont définies sur un fichier markdown dans la branche principale. Pour les utiliser, ajoutez ces secrets à votre dépôt :

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

Vous pouvez obtenir cette information auprès de votre fournisseur de messagerie. Par exemple, vous pouvez obtenir cette information auprès de votre fournisseur de messagerie :

Slack​

Les actions slack-review.yml et slack-translate.yml utilisent les mêmes déclencheurs que les versions email. Pour les utiliser, ajoutez l'URL de votre webhook Slack en tant que secret nommé SLACK_WEBHOOK_URL. Pour plus d'informations, consultez Sending messages using incoming webhooks dans la documentation de Slack.

Équipes​

Les actions teams-review.yml et teams-translate.yml fonctionnent comme les versions Slack. Microsoft supprime l'application Incoming Webhooks pour Teams à partir de décembre 2025, mais il n'y a actuellement pas de méthode GitHub publiquement disponible pour envoyer des cartes adaptatives à des flux de travail. La solution consiste à utiliser curl :

- name: Send Teams test notification
  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": "This is a test notification from GitHub Actions (Teams).", \
            "wrap": true }]}}]}'
  1. Dans Teams, accédez au canal dans lequel vous souhaitez envoyer des messages, cliquez sur l'ellipse (...) et sélectionnez Workflows.
  2. Cliquez sur Mange.
  3. Cliquez sur New flow.
  4. Recherchez des modèles pour les webhooks et cliquez sur Send webhook alerts to a channel.
  5. (Facultatif) Modifiez le Flow name.
  6. Connectez-vous et cliquez sur Next.
  7. Sélectionnez une Team et un Channel dans les listes et cliquez sur Create Flow.
  8. Copiez le MS_TEAMS_HTTP_POST_URL et stockez-le en tant que secret dans GitHub et cliquez sur Done.
Conseil

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