-
Notifications
You must be signed in to change notification settings - Fork 3
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
bhushan-nemade-dt
wants to merge
6
commits into
devtron-labs:main
Choose a base branch
from
bhushan-nemade-dt:custom-email-notifier
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
19bd2ca
gcs-create-bucket plugin doc
bhushan-nemade-dt 3368563
fix
bhushan-nemade-dt ee83b29
Custom Email Notifier plugin doc
bhushan-nemade-dt 43943f5
summary file update
bhushan-nemade-dt 281659d
Merge branch 'main' into custom-email-notifier
bhushan-nemade-dt c049eb4
Updated the steps
bhushan-nemade-dt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Custom Email Notifier | ||
|
||
## Introduction | ||
The **Custom Email Notifier** plugin by Devtron enables users to set 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 inform team members about the current status and other pipeline events. Some key use cases of this plugin can be: | ||
- Configuring notifications at pre/post stages to update teams on task completion status, such as sending vulnerability scanning reports. | ||
- Setting up automated alerts at the runbooks of auto-remediation using jobs. | ||
|
||
### 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 | ||
|
||
{% 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. | ||
{% endhint %} | ||
|
||
1. Navigate to the **Jobs** section, click **Create**, and choose **Job**. | ||
2. In the 'Create job' window, enter **Job Name** and choose a target project. | ||
3. Click **Create Job**. | ||
4. In the 'Configurations' tab, fill the required fields under the 'Source code' section and click **Save**. | ||
5. In Workflow Editor, click **+ Job Pipeline**. | ||
6. Give a name to the workflow and click **Create Workflow**. | ||
7. Click **Add job pipeline to this workflow**. | ||
8. Fill the required fields in ‘Basic configuration’ tab. | ||
9. Go to the ‘Tasks to be executed’ tab. | ||
10. Under ‘Tasks’, click the **+ Add task** button. | ||
11. Select the **Custom Email Notifier** plugin. | ||
12. 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] | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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**. | ||
|
||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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