Add ability to put ticket num in either the PR title or the git branch name #44
Conversation
|
This is a cool idea! Thanks for contributing. Let me take a deeper look at this tonight/tomorrow and follow up. 😄 |
|
Not sure why CI failed? Looks like it actually passed?! |
|
Testing this out on our repo and it appears that |
|
Check out these docs for the danger object API reference. Can’t remember off hand how to get the branch but hopefully this points you in the right direction https://danger.systems/js/reference.html#the-danger-dsl-root-objects |
|
also check out the |
|
Shockingly theres actually nothing in there to get the branch 😱. Gonna take a look at either adding it to Danger, or pulling in https://github.com/jonschlinkert/git-branch in the plugin. Thoughts? |
|
what about the value of |
|
|
- location can be either the PR title or the git branch name
| * The location of the JIRA issue, either the PR title, or the git branch | ||
| * Defaults to `title` | ||
| */ | ||
| location?: "title" | "branch"; |
There was a problem hiding this comment.
I'm sort of wondering if we should even make this an option. Part of me wants to make this plugin "smarter" or closer to "zero config" and just look in the following places for a JIRA ticket ID without requiring the user to configure this:
danger.github.pr.title- PR titledanger.github.pr.head.ref- the PR head branch name- (I think that's it right now)
What do you think about that as someone who uses this plugin? Do you want more configurability, or do you want things to Just Work™?
There was a problem hiding this comment.
Maybe also check all the commit messages too? Link all the things 🔗
There was a problem hiding this comment.
Oooh that would be pretty nice actually. What would it do if it found multiple tickets; just spit out links to all of em?
There was a problem hiding this comment.
In that vein we could remove the need to specify a JIRA key and look for anything that looks like ABC[DEF]-123? In the meantime how would you feel about merging this and tackling all of that as a follow up?
There was a problem hiding this comment.
Yeah this can be a follow up in a future release. This is a great non-breaking addition to the plugin. 🎉
|
Awesome, thanks dude. Any chance you could push a new version to NPM? |
|
Yeah lemme look at that today. I have semantic-release set up to auto-deploy, but I think my npm publishing token got revoked in the last few months, so I'll get a version published later today. |
|
🙏 ty ty |
|
🎉 This PR is included in version 1.4.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
# 1.0.0 (2023-04-13) ### Bug Fixes * **jiraIssue:** properly resolve URL ([af099b9](af099b9)) * **node:** support Node 4 ([d89d651](d89d651)) * only add one example JIRA key to warning ([macklinu#47](https://github.com/mcgrathg/danger-plugin-jira-integration/issues/47)) ([56dee38](56dee38)) ### Features * `key` is now optional field ([2acddae](2acddae)) * **$options:** Adds message format function to options ([macklinu#33](https://github.com/mcgrathg/danger-plugin-jira-integration/issues/33)) ([ecfead9](ecfead9)) * **jiraIssue:** add initial implementation ([#1](#1)) ([8638e2f](8638e2f)) * **options:** add location to options ([macklinu#44](https://github.com/mcgrathg/danger-plugin-jira-integration/issues/44)) ([96e6261](96e6261)) * support multiple JIRA issues in PR title ([86c01d0](86c01d0)), closes [macklinu#8](https://github.com/mcgrathg/danger-plugin-jira-integration/issues/8) * support multiple JIRA projects ([macklinu#26](https://github.com/mcgrathg/danger-plugin-jira-integration/issues/26)) ([f0a084f](f0a084f)), closes [macklinu#24](https://github.com/mcgrathg/danger-plugin-jira-integration/issues/24) ### BREAKING CHANGES * **jiraIssue:** this commit introduces functionality ready for a 1.0.0 release.
We label our branches with the JIRA issue rather than the PR, so I added it as an option. I haven't managed to test this with our repo yet, but hopefully it'll work 🤞