pubudu91 commented on code in PR #35397: URL: https://github.com/apache/airflow/pull/35397#discussion_r1388950665
########## docs/apache-airflow-providers-atlassian-jira/notifications/jira-notifier-howto-guide.rst: ########## @@ -0,0 +1,65 @@ + + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +How-to guide for Atlassian Jira notifications +============================================= + +Introduction +------------ +The Atlassian Jira notifier (:class:`airflow.providers.atlassian.jira.notifications.jira.JiraNotifier`) allows users to create +issues in a Jira instance using the various ``on_*_callbacks`` available at both the DAG level and Task level + +Example Code +------------ + +.. code-block:: python + + from datetime import datetime + from airflow import DAG + from airflow.operators.bash import BashOperator + from airflow.providers.atlassian.jira.notifications.jira import send_jira_notification + + with DAG( + "test-dag", + start_date=datetime(2023, 11, 3), + on_failure_callback=[ + send_jira_notification( + jira_conn_id="my-jira-conn", + description="Failure in the DAG {{ dag.dag_id }}", + summary="Airflow DAG Issue", + project_id=10000, + issue_type_id=10003, + labels=["airflow-dag-failure"], + ) + ], + ): + BashOperator( + task_id="mytask", + on_failure_callback=[ + send_jira_notification( Review Comment: > Pattern aside.. this is an example that we publish in docs so we can change it if we wish. Yes, can use either approach. But then it'll look inconsistent with the existing examples in other notifier docs though. e.g., https://airflow.apache.org/docs/apache-airflow-providers-amazon/8.6.0/notifications/chime_notifier_howto_guide.html > Isn't `on_failure_callback=ChimeNotifier(...)` Works the same and is more intuitive? Functionally, exactly the same. Personally for me, having an action verb in the name reads better in this context though. Like, on failure, send this notification. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
