Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Custom Email Notifier Plugin Doc #25

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

bhushan-nemade-dt
Copy link
Contributor

#24

@bhushan-nemade-dt bhushan-nemade-dt requested review from a team as code owners November 29, 2024 05:29
# Custom Email Notifier

## Introduction
The **Custom Email Notifier** plugin by Devtron enables user to set an automated email notifications to respective stakeholders of that specific CI/CD workflow. The Custom Email Notifier can be integrated into pre/post stages of Devtron CI/CD workflows to keep team members informed about current status and other pipeline events.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why will I use this and not native notifications from global configurations?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add usecases like, configure notification at end of job, or based on certain output of your plugins of pre-post cd, or in autoremediation

@bhushan-nemade-dt bhushan-nemade-dt requested a review from a team as a code owner January 30, 2025 05:25
## Steps

{% hint style="warning" %}
If you want to integrate the **Custom Email Notifier** plugin into pre/post stages of CI/CD pipelines, navigate to the **[Custom Webhook Notifier](https://docs.devtron.ai/usage/plugins/plugin-list/custom-webhook-notifier)** plugin and follow the steps mentioned.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the relation of custom email notifier with webhook notifier?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understood now but this is confusing, mentioning it can be added as a task in job or ci/cd pipeline is fine

| ------------------------ | ------------ | ----------- | ------------ |
| CONFIG_TYPE | STRING | Type of notification configuration. SES or SMTP | SES |
| CONFIG_NAME | STRING | Name of the notification configuration to be used. This should match an existing notification configuration in Devtron. | prod-deploy-notify |
| EMAIL_IDS | STRING | Comma-separated list of email addresses that should receive the notification. | [email protected],[email protected] |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what will be mail body? subject etc?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants