atlassian / atlassian/github-for-jira
Improve documentation on workflow transitions
- Dominant language
- No language data
- Stars
- 655
- Forks
- 194
- PR merge metrics
- No merged PRs in 30d
Description
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](https://confluence.atlassian.com/adminjiracloud/configuring-workflow-triggers-776636696.html) 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](https://github.com/integrations/jira/blob/main/SUPPORT.md#workflow-transitions-are-not-running)?) to mention workflow triggers or [Automation Actions](https://support.atlassian.com/jira-software-cloud/docs/automation-actions/#Automationactions-Transitionissue) as other ways to enable automatic workflow transitions in Jira, alternatives to relying on Smart Commits.
Thanks!
Contributor guide
No contributing guide indexed for this repository
Research direction
Open SUPPORT.md and its “Workflow transitions are not running” section, then review the existing Smart Commits guidance. Update the documentation to mention Jira Workflow Triggers and Automation Actions as alternatives, and confirm it explains how to enable automatic transitions without Smart Commits.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100