peopleworks / peopleworks/RunCommandsService

Add a Discord notifier for job alerts

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue help wanted
Dominant language
C#
Stars
10
Forks
2
PR merge metrics
No merged PRs in 30d

Description

What

Add a Discord notifier so job alerts can post to a Discord channel, alongside the existing email and webhook notifiers.

Why

Many teams live in Discord. A native notifier (or a thin adapter over the existing webhook) makes alerts land where people already are.

Suggested approach

  • Mirror the existing webhook/email notifier shape.
  • Accept a Discord webhook URL from configuration (treat it as a secret — never log it).
  • Format the alert as a Discord embed (title, status color, job name, exit code, short output tail).

Acceptance criteria

  • New notifier configurable via appsettings.json
  • Fires on the same conditions as email/webhook alerts
  • Webhook URL is never written to logs
  • A short docs note in the README configuration section

Good first issue — say hi in the comments and it's yours. 🙌

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing email and webhook notifier implementations, the appsettings.json configuration, and the README configuration section. Mirror their notifier shape for Discord embeds, then verify the acceptance criteria: matching alert conditions, protected webhook configuration, no URL in logs, and the documentation note.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
backend, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.