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
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@
* [Cosign](user-guide/plugins/cosign.md)
* [CraneCopy](user-guide/plugins/crane-copy.md)
* [GKE Provisioner](user-guide/plugins/gke-provisioner.md)
* [Custom Email Notifier](user-guide/plugins/custom-email-notifier.md)
* [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md)
* [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md)
* [Dependency track - Python](user-guide/plugins/dependency-track-python.md)
Expand Down
56 changes: 56 additions & 0 deletions docs/user-guide/plugins/custom-email-notifier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# 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

For better understanding consider a common development scenario where a developer needs to notify the operations team about build completion. Using this plugin, the developer can configure Custom Email Notifier at the post-build stage to automatically send an email notification informing that the build process has completed successfully and the Docker image is ready for deployment.

### Prerequisites
Before integrating the **Custom Email Notifier** plugin, you must ensure that you have properly configured notifications in your Devtron setup. For detailed notification configuration steps, please refer to the Devtron documentation at: [Devtron Notifications](https://docs.devtron.ai/global-configurations/manage-notification).

---

## Steps
1. Go to **Applications** → **Devtron Apps**.
2. Click your application.
3. Go to **App Configuration** → **Workflow Editor**.
4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**.
5. Fill the required fields in the **Create build pipeline** window and navigate to the **Post-build stage**.

{% hint style="warning" %}
If you have already configured workflow, edit the build pipeline, and navigate to **Post-build stage**.
{% endhint %}

6. Under 'TASKS', click the **+ Add task** button.
7. Click the **Custom Email Notifier** plugin.
8. Enter the following [user inputs](#user-inputs) with appropriate values.
---

## User Inputs

### Task Name
Enter the name of your task

e.g., `Email Notifier`

### Description
Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task.

e.g., `The Custom Email Notifier plugin is integrated for sending an automated email notifications to relevant stakeholders.`

### Input Variables
| Variable | Format | Description | Sample Value |
| ------------------------ | ------------ | ----------- | ------------ |
| 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?


### Trigger/Skip Condition
Here you can set conditions to execute or skip the task. You can select `Set trigger conditions` for the execution of a task or `Set skip conditions` to skip the task.

### Output Variables
Custom Email Notifier will not be generating an output variable.

Click **Update Pipeline**.