atlassian / atlassian/github-for-jira

Tracking deployments has limited functionality

Open
#2,421 4 comments 4 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
655
Forks
194
PR merge metrics
No merged PRs in 30d

Description

Tracking of GH deployments and transforming them to Jira deployments is limited and it's leaking Jira into Github VSC:
* Parse only Jira key from commit message
* Leaks Jira app rules into commit message guidelines and forcing change of commit message guidelines
* Doesn't analyse GH Deployment `payload` field or other GH deployment fields

All that results in stiff and strict solution for tracking deployments.

Instead Jira App for GH should parse Jira keys from:
* PR connected to commit
* PR title
* PR body
* GH deployment `payload` field
* This would allow engineers to inject Jira keys manually in CI adding flexibility and robustness to it considering we are running GHA in various cases

Simplest solution would be just to add [here](https://github.com/atlassian/github-for-jira/blob/main/src/transforms/transform-deployment.ts#L371) also `deployment.payload`

```
jiraIssueKeyParser(`${deployment.ref}\n${message}\n${allCommitsMessages}\n${deployment.payload}`),
```

And we would have capability to inject Jira keys from outside in flexible way without requirement to change commit messages to contain Jira key.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start in src/transforms/transform-deployment.ts around line 371 and inspect jiraIssueKeyParser plus the deployment fields already passed to it. Check how connected pull requests, PR titles and bodies, and deployment payloads are represented before deciding the supported inputs. Done means Jira keys can be discovered from the requested deployment and PR data without requiring commit-message changes, with relevant tests updated or added.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, github-actions
Domain
backend, devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.