Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.73 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.73 KB

JIRAMobileKit

CI Status Version License Platform

JIRA Mobile KIT is a plugin written from the group up in swift to enable fast

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

Installation

JIRAMobileKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "JIRAMobileKit"

Configuring

To start JIRA you can setup the JIRA connection using the following command:

JIRA.shared.setup(host: "[[JIRA_URL]]", project: "[[PROJECT_KEY]]", defaultIssueType: "[[DEFAULT_ISSUE_TYPE]]")

The parameters you should use:

  • [[JIRA_URL]] - this is the url of where to your jira instance is located. Eg for a cloud JIRA install it is https://company.atlassian.net
  • [[PROJECT_KEY]] - this is the short key related to your project. Note your tickets for a project get created like [[PROJECT_KEY]]-TicketNumber
  • [[DEFAULT_ISSUE_TYPE]] - (optional) this is the name of your ticket type. By default it is set as Bug.

Raising an issue

Then to raise a JIRA issue:

JIRA.shared.raise()

Author

willpowell8, willpowell8@gmail.com

License

JIRAMobileKit is available under the MIT license. See the LICENSE file for more info.