atlassian / atlassian/github-for-jira
Pull Request descriptions being edited by Jira
- Dominant language
- No language data
- Stars
- 655
- Forks
- 194
- PR merge metrics
- No merged PRs in 30d
Description
It seems like there was a recent change that was introduced which is _constantly_ editing our pull request descriptions. It looks like something is pattern matching the ticket format and then appending a (poorly formatted imo) bit of text at the end.
A few issues with this. We squash our PRs and merge in the description of the PR as the commit message. We also use [git trailers](https://git-scm.com/docs/git-interpret-trailers) which are expected to be *at the end of the commit*. The bot appending it's own information at the end messes with this.
Another thing... it doesn't even work correctly. We have a PR template which contains docblocks explaining parts of the template. This is the explanation on using git trailers along with the ticket for the PR that I added, and the line that the bot injected.
```markdown
## Context
ticket: MW-6010
[MW-1234]: https://resideo.atlassian.net/browse/MW-1234?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
```
As you can see the `[MW-1234]: http://resideo...` bit at the end was injected because it picked up the *fake/example* ticket number from `ticket: MW-1234` which is in a docblock. The real ticket was `MW-6010` which _was_ in the proper place for the trailer until the Jira integration comes stomping through.
Is there anyway to turn this behavior off?
Contributor guide
No contributing guide indexed for this repository
Research direction
No files, tests, or entry points are named in the issue. Start by confirming whether the Jira-to-GitHub description editing behavior is still handled in this repository; its description says the project is deprecated and has moved to a private repository. Done would mean identifying whether the behavior can be disabled without corrupting PR templates or commit trailers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, github
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 20/100