Tips

References

 

Test your workflow!

Workflows can be complicated (smile). Define a reasonable test scenario for your workflow on a test project or test system. Often, it is the only way to find errors before putting your workflow in production. Consider formalizing your workflow testing with GINT - Groovy Integration Test Framework. In the future, a simple GINT workflow test example will be provided (smile).

Errors

Post functions are run after the transition has already occurred - there is no turning back. If your post function has configuration errors, the JIRA server log is the only place those will be reported. When testing and debugging your workflow configuration, make sure you have access to the log and ensure your changes have not introduced unnoticed errors. If necessary, follow How to get problem determination information.

Running actions related to issue being transitioned

Some people run JCLI actions on the local instance. Generally, this works, but there are cases that may not if the issue that initiated the transition is involved in the action. For these cases, look for specific add-ons that provide capabilities for dealing with the issue being transitioned. For instance, Update on Transition for Jira is recommended for updating issues instead of using updateIssue from the CLI. Similarly, Create on Transition for Jira should be used for creating issues rather than using createIssue.

More specifically, use the simplest post function that meets your needs before using the JCLI action when dealing with a local instance.

Post function ordering

It is important for workflow designers to understand how the order of processing can affect results. Some actions will not behave properly if done in the wrong sequence. Think carefully and try alternative ordering in your tests.