Leave a comment on a Jira ticket
|Supported platforms||ios, android, mac|
|Returns||A hash containing all relevant information of the Jira comment
Access Jira comment 'id', 'author', 'body', and more
jira( url: "https://bugs.yourdomain.com", username: "Your username", password: "Your password or API token", ticket_id: "IOS-123", comment_text: "Text to post as a comment" )
jira( url: "https://yourserverdomain.com", context_path: "/jira", username: "Your username", password: "Your password or API token", ticket_id: "IOS-123", comment_text: "Text to post as a comment" )
jira( ticket_id: "IOS-123", comment_text: "Text to post as a comment", fail_on_error: false )
||URL for Jira instance|
||Appends to the url (ex: "/jira")||
||Username for Jira instance|
||Password or API token for Jira|
||Ticket ID for Jira, i.e. IOS-123|
||Text to add to the ticket as a comment|
||Should an error adding the Jira comment cause a failure?||
* = default value is dependent on the user's system
Actions can communicate with each other using a shared hash
lane_context, that can be accessed in other actions, plugins or your lanes:
jira action generates the following Lane Variables:
||The whole Jira API JSON object|
To get more information check the Lanes documentation.
To show the documentation in your terminal, run
fastlane action jira
It is recommended to add the above action into your
Fastfile, however sometimes you might want to run one-offs. To do so, you can run the following command from your terminal
fastlane run jira
To pass parameters, make use of the
: symbol, for example
fastlane run jira parameter1:"value1" parameter2:"value2"
It's important to note that the CLI supports primitive types like integers, floats, booleans, and strings. Arrays can be passed as a comma delimited string (e.g.
param:"1,2,3"). Hashes are not currently supported.
It is recommended to add all fastlane actions you use to your
This action, just like the rest of fastlane, is fully open source, view the source code on GitHub