osowskit / jira-link-updater Goto Github PK

Problem

#7 requires that the JIRA fqdn is stored in a YAML file.

Discussion

It is possible to create an issue in each repository that can't load a JIRA URL stating jira-link-updater GitHub App requires the YAML file, displays a warning if the YAML is malformed, and possibly creates the YAML file as a template.

This app was written to assume GitHub Enterprise instance with a single JIRA url. This limits installations for both companies with multiple JIRA instances and .com users.

• Handle API calls for both GHE and .com
• #7 load JIRA hostname per repository
• Consider queuing webhook events and processing them later

Problem

Loading the JIRA_HOSTNAME from an environment variable ties a single running app to one url. This limits allowing multiple JIRA instances - either on an internal network or for supporting github.com.

Requirements

• Define YAML file that needs to exist in each repository
• Modify App permissions to read a single file
• Modify App to read and use this information
• Determine how to cache JIRA URLs
  • Reading this file for each webhook can have serious performance implications

Handle pull_request created event and replace matches in body

Consider replacing ID in the title hyperlinks in title don't show up so can be ignored

The source currently ignores issue_comment : updated events to naively avoid processing this integration updating a comment

The webhook payload will contain returns a sender:type:Bot that can be checked to ignore an update by this integration. However, for a user update - this may not prevent the app attempting to nest the link.

Problem

Very active repositories may eventually time out with serial processing of webhooks. GitHub may also be temporarily unavailable so handle retrying.

Discussion

• Store webhook events and process them separately.
• Gracefully fail when GitHub's API is unavailable
• Cache the jira URL instead of loading it each webhook

Handle multiple occurrences of matching JIRA IDs in a comment.

Don't hardcode path to Atlassian JIRA server. This should be configurable from YAML or Environment Variables.