jira

3 Examples

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
)

Parameters

Key	Description	Default
`url`	URL for Jira instance
`context_path`	Appends to the url (ex: "/jira")	`''`
`username`	Username for Jira instance
`password`	Password or API token for Jira
`ticket_id`	Ticket ID for Jira, i.e. IOS-123
`comment_text`	Text to add to the ticket as a comment
`fail_on_error`	Should an error adding the Jira comment cause a failure?	`true`

* = default value is dependent on the user's system

Lane Variables

Actions can communicate with each other using a shared hash lane_context, that can be accessed in other actions, plugins or your lanes: lane_context[SharedValues:XYZ]. The jira action generates the following Lane Variables:

SharedValue	Description
`SharedValues::JIRA_JSON`	The whole Jira API JSON object

To get more information check the Lanes documentation.

Documentation

To show the documentation in your terminal, run

fastlane action jira

CLI

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 Fastfile.

Source code

This action, just like the rest of fastlane, is fully open source, view the source code on GitHub

Back to actions

jira
Supported platforms	ios, android, mac
Author	@iAmChrisTruman, @crazymanish
Returns	A hash containing all relevant information of the Jira comment Access Jira comment 'id', 'author', 'body', and more