Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pakej/fastlane-plugin-jira-issue
Get the jira issue and its details for the given jira issue key.
https://github.com/pakej/fastlane-plugin-jira-issue
fastlane fastlane-plugin issue-details jira jira-issue jira-ticket
Last synced: about 2 months ago
JSON representation
Get the jira issue and its details for the given jira issue key.
- Host: GitHub
- URL: https://github.com/pakej/fastlane-plugin-jira-issue
- Owner: pakej
- License: mit
- Created: 2018-11-25T05:52:50.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2021-01-05T15:33:36.000Z (almost 4 years ago)
- Last Synced: 2024-10-02T20:17:29.244Z (3 months ago)
- Topics: fastlane, fastlane-plugin, issue-details, jira, jira-issue, jira-ticket
- Language: Ruby
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jira Issue Details `fastlane` Plugin [](https://app.bitrise.io/app/72df6f31dbaba55c)
[](https://rubygems.org/gems/fastlane-plugin-jira_issue_details) [](https://badge.fury.io/rb/fastlane-plugin-jira_issue_details)
## Getting Started
This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-jira_issue_details`, add it to your project by running:
```bash
fastlane add_plugin jira_issue_details
```
## About This Plugin
Get the details for the given jira issue key.
It utilises the [jira-ruby gem](https://github.com/sumoheavy/jira-ruby) to communicate with Jira and get the details of the Jira issue for the given key. If the key does not exists, it will just return `nil`.
(Currently only supports basic `auth_type` login)
## Actions
### get_jira_issue
Get the jira issue by passing the `username`, `api_token`, `site` and `issue_key` parameters. You can later get the details that you need by accessing the string keys. The reference to all the keys can be found [here](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-api-3-issue-issueIdOrKey-get), just scroll to the `responses` section.
Do note that all parameters are required, otherwise the action will return `nil`.
1. Passing a single jira `issue_key`
In return, you'll get a single hash, or `nil` if the issue for the given key was not found.
```ruby
issue = get_jira_issue(
username: '[email protected]',
api_token: 'yourapitoken',
site: 'https://your-domain.atlassian.net',
issue_key: 'TKT-123'
)
summary = issue['fields']['summary']
puts summary
#=> Short summary for the ticket id TKT-123
```
1. Passing multiple jira `issue_key`s (Do note that you should **only** separate the keys using a single space ` `)
In return, you'll get a hash of `key-hash` pair, or `key-nil` pair if the issue was not found.
```ruby
issue = get_jira_issue(
username: '[email protected]',
api_token: 'yourapitoken',
site: 'https://your-domain.atlassian.net',
issue_key: 'TKT-123 TKT-456'
)
summary = issue['TKT-123']['fields']['summary']
puts summary
#=> Short summary for the ticket id: TKT-123
# assuming TKT-456 doesn't exist
summary = issue['TKT-456']
puts summary
#=> nil
```
Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
## Issues and Feedback
For any other issues and feedback about this plugin, please submit it to this repository.
## Troubleshooting
If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
## Using `fastlane` Plugins
For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
## About `fastlane`
`fastlane` is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).