Skip to content

Commit

Permalink
Fixes #18099: Document notification email feature
Browse files Browse the repository at this point in the history
  • Loading branch information
ElaadF committed Sep 4, 2020
1 parent dc17a08 commit 146f8be
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions change-validation/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -196,17 +196,39 @@ image::docs/images/Warning.png[]

=== Email notification

You can setup email notification at each step of change request workflow.
You will need to fill the informations about the mail server settings, to whom it should be sent, the file is located at :
You can set up email notification at each step of change request workflow.
You will need to fill the information about the mail server settings and to whom it should be sent for each step, this file is located at :
`/opt/rudder/etc/plugins/change-validation.conf`



For each step you can set up a email's template, by default is located at :
For each step you can set up an email's template, we provide templates, by default they are located at :

`/var/rudder/plugins/change-validation/{step name}-mail.template`

> NOTE: You can move the template file, but you will need to modify the location in `change-validation.conf`
Here is an example:
[source,mustache]
----
# Pending validation
validation.to="JaneDoe@acme.com"
validation.cc="JohnDo@acme.io,shelly@acme.com"
validation.bcc="jcvd@acme.com"
validation.subject="""[Pending Validation] CR #{{id}}: {{name}}"""
validation.replyTo="no-reply@acme.com"
validation.template="/var/rudder/plugins/change-validation/validation-mail.template"
----

Here a list of parameter available to use in the template:
- author
- link
- name
- description

These parameters can also be used in `subject` parameter in the configuration file.

> NOTE: You can change the templates' locations, but you will need to modify the parameter `{step name}.template` in `change-validation.conf`



== Validated User

Expand Down

0 comments on commit 146f8be

Please sign in to comment.