You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by ka...@apache.org on 2021/01/16 01:11:49 UTC

[airflow] branch master updated: Add Missing Email configs in Configuration doc (#13709)

This is an automated email from the ASF dual-hosted git repository.

kaxilnaik pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airflow.git


The following commit(s) were added to refs/heads/master by this push:
     new 1ab19b4  Add Missing Email configs in Configuration doc (#13709)
1ab19b4 is described below

commit 1ab19b40fdea3d6399fcab4cd8855813e0d232cf
Author: Kaxil Naik <ka...@gmail.com>
AuthorDate: Sat Jan 16 01:11:35 2021 +0000

    Add Missing Email configs in Configuration doc (#13709)
    
    closes https://github.com/apache/airflow/issues/13697
---
 airflow/config_templates/config.yml          | 18 ++++++++++++++++++
 airflow/config_templates/default_airflow.cfg | 10 ++++++++++
 2 files changed, 28 insertions(+)

diff --git a/airflow/config_templates/config.yml b/airflow/config_templates/config.yml
index af437db..da79a4f 100644
--- a/airflow/config_templates/config.yml
+++ b/airflow/config_templates/config.yml
@@ -1262,6 +1262,24 @@
       type: boolean
       example: ~
       default: "True"
+    - name: subject_template
+      description: |
+        File that will be used as the template for Email subject (which will be rendered using Jinja2).
+        If not set, Airflow uses a base template.
+      version_added: ~
+      type: string
+      example: "/path/to/my_subject_template_file"
+      default: ~
+      see_also: ":doc:`Email Configuration </howto/email-config>`"
+    - name: html_content_template
+      description: |
+        File that will be used as the template for Email content (which will be rendered using Jinja2).
+        If not set, Airflow uses a base template.
+      version_added: ~
+      type: string
+      example: "/path/to/my_html_content_template_file"
+      default: ~
+      see_also: ":doc:`Email Configuration </howto/email-config>`"
 
 - name: smtp
   description: |
diff --git a/airflow/config_templates/default_airflow.cfg b/airflow/config_templates/default_airflow.cfg
index ccd6a95..3c9adeb 100644
--- a/airflow/config_templates/default_airflow.cfg
+++ b/airflow/config_templates/default_airflow.cfg
@@ -626,6 +626,16 @@ default_email_on_retry = True
 # Whether email alerts should be sent when a task failed
 default_email_on_failure = True
 
+# File that will be used as the template for Email subject (which will be rendered using Jinja2).
+# If not set, Airflow uses a base template.
+# Example: subject_template = /path/to/my_subject_template_file
+# subject_template =
+
+# File that will be used as the template for Email content (which will be rendered using Jinja2).
+# If not set, Airflow uses a base template.
+# Example: html_content_template = /path/to/my_html_content_template_file
+# html_content_template =
+
 [smtp]
 
 # If you want airflow to send emails on retries, failure, and you want to use