{"id":20841446,"url":"https://github.com/pakej/fastlane-plugin-jira-issue","last_synced_at":"2025-05-08T22:10:42.354Z","repository":{"id":55343201,"uuid":"159002423","full_name":"pakej/fastlane-plugin-jira-issue","owner":"pakej","description":"Get the jira issue and its details for the given jira issue key.","archived":false,"fork":false,"pushed_at":"2021-01-05T15:33:36.000Z","size":25,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-04-15T06:38:50.757Z","etag":null,"topics":["fastlane","fastlane-plugin","issue-details","jira","jira-issue","jira-ticket"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pakej.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-25T05:52:50.000Z","updated_at":"2024-08-03T10:35:27.000Z","dependencies_parsed_at":"2022-08-14T21:41:34.871Z","dependency_job_id":null,"html_url":"https://github.com/pakej/fastlane-plugin-jira-issue","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pakej%2Ffastlane-plugin-jira-issue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pakej%2Ffastlane-plugin-jira-issue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pakej%2Ffastlane-plugin-jira-issue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pakej%2Ffastlane-plugin-jira-issue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pakej","download_url":"https://codeload.github.com/pakej/fastlane-plugin-jira-issue/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253154975,"owners_count":21862622,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fastlane","fastlane-plugin","issue-details","jira","jira-issue","jira-ticket"],"created_at":"2024-11-18T01:20:08.459Z","updated_at":"2025-05-08T22:10:42.299Z","avatar_url":"https://github.com/pakej.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jira Issue Details `fastlane` Plugin [![Build Status](https://app.bitrise.io/app/72df6f31dbaba55c/status.svg?token=eNywJtIKO1opSsI9PbEHVQ\u0026branch=develop)](https://app.bitrise.io/app/72df6f31dbaba55c)\n\n[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-jira_issue_details) [![Gem Version](https://badge.fury.io/rb/fastlane-plugin-jira_issue_details.svg)](https://badge.fury.io/rb/fastlane-plugin-jira_issue_details)\n\n## Getting Started\n\nThis 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:\n\n```bash\nfastlane add_plugin jira_issue_details\n```\n\n## About This Plugin\n\nGet the details for the given jira issue key.\n\nIt 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`.\n\n(Currently only supports basic `auth_type` login)\n\n## Actions\n\n### get_jira_issue\n\nGet 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.\n\nDo note that all parameters are required, otherwise the action will return `nil`.\n\n1. Passing a single jira `issue_key`\n    \n    In return, you'll get a single hash, or `nil` if the issue for the given key was not found.\n\n    ```ruby\n    issue = get_jira_issue(\n      username: 'you@domain.com',\n      api_token: 'yourapitoken',\n      site: 'https://your-domain.atlassian.net',\n      issue_key: 'TKT-123'\n    )\n\n    summary = issue['fields']['summary']\n    puts summary\n    #=\u003e Short summary for the ticket id TKT-123\n    ```\n\n1. Passing multiple jira `issue_key`s (Do note that you should **only** separate the keys using a single space ` `)\n\n    In return, you'll get a hash of `key-hash` pair, or `key-nil` pair if the issue was not found.\n\n    ```ruby\n    issue = get_jira_issue(\n      username: 'you@domain.com',\n      api_token: 'yourapitoken',\n      site: 'https://your-domain.atlassian.net',\n      issue_key: 'TKT-123 TKT-456'\n    )\n\n    summary = issue['TKT-123']['fields']['summary']\n    puts summary\n    #=\u003e Short summary for the ticket id: TKT-123\n\n    # assuming TKT-456 doesn't exist\n    summary = issue['TKT-456']\n    puts summary\n    #=\u003e nil\n    ```    \n\nCheck 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`.\n\n## Issues and Feedback\n\nFor any other issues and feedback about this plugin, please submit it to this repository.\n\n## Troubleshooting\n\nIf you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.\n\n## Using `fastlane` Plugins\n\nFor more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).\n\n## About `fastlane`\n\n`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). \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpakej%2Ffastlane-plugin-jira-issue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpakej%2Ffastlane-plugin-jira-issue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpakej%2Ffastlane-plugin-jira-issue/lists"}