search

atlassian / github-for-jira

Connect your code with your project management in Jira
https://github.atlassian.com
MIT License
623 stars 188 forks source link

Improve documentation on workflow transitions #381

Open usmonster opened 4 years ago

usmonster commented 4 years ago

I want my team to be able to take advantage of workflow transitions without having to learn Smart Commits.

I saw after setting up the Jira integration that this is already the case for one of the projects—transitions just work as expected based on workflow states—but it didn't work with other projects.

It took me way too long to confirm the reason: someone had previously enabled Workflow Triggers on the first project.

I somehow thought this was something that would've been auto-configured by the integration, but I understand why that would be impossible to do accurately for all possible Jira workflows. Instead, I'd suggest at least adding something to the documentation (maybe SUPPORT.md?) to mention workflow triggers or Automation Actions as other ways to enable automatic workflow transitions in Jira, alternatives to relying on Smart Commits.

Thanks!

rachellerathbone commented 3 years ago

Hi @usmonster (again). I've also added the to triage label to this issue for my team to discuss.

ccrolf commented 2 years ago

Thanks for the suggestion @usmonster . The preferred way to auto-transition issues is Jira Automation. It's far easier to configure than workflow triggers. Please have a look at the docs here: https://community.atlassian.com/t5/Automation-articles/New-automation-triggers-across-Jira-Cloud-Bitbucket-GitLab-amp/ba-p/1337351

usmonster commented 2 years ago

Hi @ccrolf, thanks for the link. I've seen the documentation and use Jira Automation regularly. My intention with this issue is to explicitly mention that preference somewhere in this repository's documentation (i.e. here). Today, there seems to be a focus on Smart Commits, which doesn't show the whole picture.