Class: Fastlane::Actions::GetJiraIssueAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



21
22
23
 
# File 'lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb', line 21

def self.authors
  ["Zaim Ramlan"]
end

.available_options ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb', line 36

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :username,
                            env_name: "JIRA_ISSUE_DETAILS_USERNAME",
                         description: "Your Jira Username",
                            optional: false,
                                type: String),

    FastlaneCore::ConfigItem.new(key: :api_token,
                            env_name: "JIRA_ISSUE_DETAILS_API_TOKEN",
                         description: "Your Jira API Token",
                            optional: false,
                                type: String),

    FastlaneCore::ConfigItem.new(key: :site,
                            env_name: "JIRA_ISSUE_DETAILS_SITE",
                         description: "Your Jira Site ('http://yourdomain.atlassian.net')",
                            optional: false,
                                type: String),

    FastlaneCore::ConfigItem.new(key: :issue_key,
                            env_name: "JIRA_ISSUE_DETAILS_ISSUE_KEY",
                         description: "Your Jira Issue Key(s). Separate with a single space ` ` to add more keys",
                            optional: false,
                                type: String)
  ]
end

.description ⇒ Object 



17
18
19
 
# File 'lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb', line 17

def self.description
  "Get the details for the given jira issue key(s)."
end

.details ⇒ Object 



32
33
34
 
# File 'lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb', line 32

def self.details
  "It utilises the `jira-ruby` gem to communicate with Jira and get the details of the Jira issue for the given key.\n\n(Currently only supports basic auth_type login)."
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
 
# File 'lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb', line 64

def self.is_supported?(platform)
  true
end

.return_value ⇒ Object 



25
26
27
28
29
30
 
# File 'lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb', line 25

def self.return_value
  single_key = "it returns a `Hash` containing the details of the jira issue for the given key, or `nil` if the issue key does not exists."
  multiple_key = "it returns a `Hash` of `key-Hash` pairs containing the details of the jira issue key, or `key-nil` pair if the issue key does not exists."

  "For single jira issue key, #{single_key} For multiple jira issue keys, #{multiple_key}"
end

.run(params) ⇒ Object 



8
9
10
11
12
13
14
15
 
# File 'lib/fastlane/plugin/jira_issue_details/actions/get_jira_issue.rb', line 8

def self.run(params)
  input = get_input_from_env
  input = get_input_from(params) if is_exists?(params)
  return nil if is_nil_any(input)

  client = JIRA::Client.new(options_for_jira_client(input))
  return get_issues_from(client, input)
end