Steve Lawrence created DAFFODIL-3062:
----------------------------------------

             Summary: Disable JIRA notifications from GitHub pull requests
                 Key: DAFFODIL-3062
                 URL: https://issues.apache.org/jira/browse/DAFFODIL-3062
             Project: Daffodil
          Issue Type: Improvement
          Components: Infrastructure
            Reporter: Steve Lawrence


The asf.yml file has a `notifications.jira_options` option that says what 
actions to take when a pull request is created or updated and it has a jira 
ticket number in the commit title. From the asf.yml documentation, the possible 
values (of which you can have multiple) are:

* comment: Add the PR/issue event as a comment in the referenced Jira ticket.
* worklog: Add the event as a worklog entry instead of a comment in the Jira 
ticket you reference.
* label: Add a 'pull-request-available' label to referenced tickets. NOTE: Some 
Jira projects have set limitations on who can add labels to tickets. If labels 
are not being added, you can address this by granting the Jira user githubbot 
access to your Jira space as a committer.
* link: When you create a GitHub PR/issue, embed a link to the PR or issue in 
the Jira ticket you reference.

I can't find documentation on what the default value is, but "worklog" is 
definitely one of them. This means every time a PR is created or commented with 
a ticket in the title, it adds an entry to the worklog which sends out an 
email. We already get PR emails so the worklog entry really does not add much 
value and just leads to excess emails.

So we should modify .asf.yml to set the jira_option to something more suitable 
that does not include worklog. I think "label" and "link" would be helpful, 
sufficient, and should not create excessive emails.

We should also consider if we want to start including JIRA ticket identifiers 
in commit titles to take advantage of this capability. Personally, I like our 
current standard since I find ticket numbers in commit titles tend to add more 
clutter than value. Maybe we could ask infra if they could add support for 
finding ticket numbers in the body of a commit rather than only in the title so 
we could keep our current convention but get the benefits of JIRA integration.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to