abianche/skroll

Add Discord notifications (single status + per-area summary) to unified CI

Open

#48 geöffnet am 14. Sept. 2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (0 Forks)auto 404
help wanted

Repository-Metriken

Stars
 (0 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Description

Enhance the unified CI workflow to post one Discord message per run (pass/fail/cancelled), including a brief per-area result summary (backend/frontend). Uses a repository secret DISCORD_WEBHOOK_URL.

Motivation

  • One clean message per run for better signal/noise
  • Centralized status across areas

Prerequisites

Create a Discord webhook and add a GitHub Actions secret: Name: DISCORD_WEBHOOK_URL Value: (Discord webhook URL)

Scope

  • Add a final notify job that:
    • Depends on all per-area jobs (and runs even if they fail)
    • Aggregates overall conclusion + per-area statuses
    • Posts one Discord message to the webhook
    • Update CONTRIBUTING.md with setup/behavior details for the webhook and notification format

Out of Scope

  • Changing build/test commands
  • Per-environment deploys

Acceptance Criteria

  • A single Discord message is posted per workflow run with:
    • Overall status (pass/fail/cancelled)
    • Per-area results (backend/frontend) shown clearly
    • Link to the run/PR
  • CONTRIBUTING.md documents the webhook secret and how notifications work

Docs Updates

  • In CONTRIBUTING.md, add:
    • How to create & store the DISCORD_WEBHOOK_URL secret
    • What the message looks like and when it sends
    • Troubleshooting (e.g., missing secret, non-200 response)

Contributor Guide

Research-Richtung
Untersuche die vorhandene CI Workflow Datei, um die Jobs pro Bereich und deren Struktur zu verstehen. Lerne, wie man mit `needs` und `if: always()` Job Schlussfolgerungen aggregiert. Recherchiere die Formatierung von Discord Webhook Nachrichten und wie man eine POST Anfrage von einem GitHub Actions Schritt sendet. Aktualisiere CONTRIBUTING.md mit den Einrichtungsanweisungen für den Webhook und dem Benachrichtigungsverhalten.
Tech Stack
typescriptnodejsgithub actions
Domain
ci cd
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitDiscord webhookGitHub Actions secrets
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80