Package Documentation
Storm Package: synapse-jira
The following Commands are available from this package. This documentation is generated for version 1.3.1 of the package.
Storm Commands
This package implements the following Storm Commands.
jira.issue.create
Create a simple JIRA issue.
This command requires a project identifier, issue type, and summary to create a
new issue.
The jira.issue.types command can be used to determine the available issue types
which can be used for the project specified.
Additional fields may be specified by providing a dictionary with the field names
and values to the --fields argument of this command.
Example:
// Create an issue of type "Bug" in the project "MDR"
jira.issue.create MDR Bug "As: User Want: More data So: Analysis"
Usage: jira.issue.create [options] <project> <type> <summary>
Options:
--help : Display the command usage.
--fields <fields> : Extra fields to add when creating the issue (default: None)
--debug : Show verbose debug output.
Arguments:
<project> : Jira project to create the issue in.
<type> : Type of issue to create.
<summary> : Title of the issue.
jira.issue.search
Search for Jira issues using a JQL query.
By default this command will create proj:ticket nodes, as well as proj:project
and proj:comment nodes, from the results returned by the submitted JQL query.
If the --dry-run argument is provided the command will only print out the issues.
Example:
// Search for issues in project "MDR" with priority "Highest"
// and create nodes from the results
jira.issue.search 'project = "MDR" and priority="Highest"'
// Search for issues in project "MDR" with priority "Highest"
// and yield proj:ticket nodes
jira.issue.search 'project = "MDR" and priority="Highest"' --yield
// Create nodes without applying Jira labels as tags
jira.issue.search 'project = "MDR" and priority="Highest"' --no-tags
// Search for issues in project "MDR" with priority "Highest"
// and only display the results
jira.issue.search 'project = "MDR" and priority="Highest"' --dry-run
Usage: jira.issue.search [options] <query>
Options:
--help : Display the command usage.
--size <size> : Maximum number of issues to return. (default: 100)
--dry-run : Only display the results and do not create nodes.
--no-tags : Construct nodes but do not record tags returned by the Jira API.
--yield : Yield the newly created proj:ticket nodes.
--debug : Show verbose debug output.
Arguments:
<query> : The JQL query to submit.
jira.issue.transition
Change the status of a JIRA issue.
The jira.issue.transition.options command can be used to determine the
available target transition options for an issue.
Example:
// Change the status of issue "MDR-8" to "pending"
jira.issue.transition "MDR-8" "pending"
Usage: jira.issue.transition [options] <issue> <target>
Options:
--help : Display the command usage.
--fields <fields> : Extra fields to add when transitioning the issue (default: None)
--debug : Show verbose debug output.
Arguments:
<issue> : Jira issue to transition.
<target> : Status to transition the issue to.
jira.issue.transition.options
Get the available transition options for a given issue.
The output from this command displays the available target transition options
for an issue which can be provided to the jira.issue.transition command.
Example:
// Get the available transition options for issue "MDR-8"
jira.issue.transition.options "MDR-8"
Usage: jira.issue.transition.options [options] <issue>
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
Arguments:
<issue> : Jira issue to transition.
jira.issue.types
List the available issue types for a project.
The output from this command displays the available issue types which can
be provided when creating an issue using the jira.issue.create command.
Example:
// List the available issue types in the project "MDR"
jira.issue.types MDR
Usage: jira.issue.types [options] <project>
Options:
--help : Display the command usage.
--debug : Show verbose debug output.
Arguments:
<project> : Jira project to list issue types for.
jira.setup.apikey
Set the Jira API key.
Usage: jira.setup.apikey [options] <apikey>
Options:
--help : Display the command usage.
--self : Set the key as a user variable. If not used, the key is set globally.
Arguments:
<apikey> : The Jira API key string.
jira.setup.domain
Set the domain name to use when making Jira HTTP API requests.
Usage: jira.setup.domain [options] <domain>
Options:
--help : Display the command usage.
--self : Set the domain as a user variable. If not used, the domain is set globally.
Arguments:
<domain> : The Jira domain such as "vertexproject.atlassian.net"
jira.setup.tagprefix
Set the tag prefix used when recording Jira labels as tags.
The default tag prefix is "rep.jira" if not specified.
Any tags provided by Jira API will be added within the given namespace.
For example, the Jira label "foo" would result in "#rep.jira.foo". Any
characters incompatible with tag names are replaced with "_".
Usage: jira.setup.tagprefix [options] <tagname>
Options:
--help : Display the command usage.
Arguments:
<tagname> : The tag prefix to use.
jira.setup.username
Set the Jira user name to use when making Jira HTTP API requests.
Usage: jira.setup.username [options] <username>
Options:
--help : Display the command usage.
--self : Set the user name as a user variable. If not used, the user name is set globally.
Arguments:
<username> : The Jira user name such as "[email protected]".
jira.users
Display the list of Jira users.
Usage: jira.users [options]
Options:
--help : Display the command usage.
--size <size> : Maximum number of users to return. (default: 100)
--debug : Show verbose debug output.
Storm Modules
This package does not export any Storm APIs.