Class: Fastlane::Actions::GetJiraReleaseReportLinkAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



157
158
159
 
# File 'lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb', line 157

def self.authors
  [ "https://github.com/alexeyn-martynov" ]
end

.available_options ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb', line 76

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :url,
                                env_name: "FL_JIRA_UTIL_SITE",
                                description: "URL for Jira instance",
                                type: String,
                                verify_block: proc do |value|
                                  UI.user_error!("No url for Jira given, pass using `url: 'url'`") unless value and !value.empty?
                                end),
    FastlaneCore::ConfigItem.new(key: :username,
                                 env_name: "FL_JIRA_UTIL_USERNAME",
                                 description: "Username for JIRA instance",
                                 type: String,
                                 verify_block: proc do |value|
                                   UI.user_error!("No username given, pass using `username: 'jira_user'`") unless value and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :password,
                                 env_name: "FL_JIRA_UTIL_PASSWORD",
                                 description: "Password for Jira",
                                 type: String,
                                 verify_block: proc do |value|
                                   UI.user_error!("No password given, pass using `password: 'T0PS3CR3T'`") unless value and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :project_name,
                                 env_name: "FL_JIRA_UTIL_PROJECT_NAME",
                                 description: "Project ID for the JIRA project. E.g. the short abbreviation in the JIRA ticket tags",
                                 type: String,
                                 optional: true,
                                 conflicting_options: [:project_id],
                                 conflict_block: proc do |value|
                                   UI.user_error!("You can't use 'project_name' and '#{project_id}' options in one run")
                                 end,
                                 verify_block: proc do |value|
                                   UI.user_error!("No Project ID given, pass using `project_id: 'PROJID'`") unless value and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :project_id,
                                 env_name: "FL_JIRA_UTIL_PROJECT_ID",
                                 description: "Project ID for the JIRA project. E.g. the short abbreviation in the JIRA ticket tags",
                                 type: String,
                                 optional: true,
                                 conflicting_options: [:project_name],
                                 conflict_block: proc do |value|
                                   UI.user_error!("You can't use 'project_id' and '#{project_name}' options in one run")
                                 end,
                                 verify_block: proc do |value|
                                   UI.user_error!("No Project ID given, pass using `project_id: 'PROJID'`") unless value and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :version_id,
                                 description: "JIRA version id. E.g. 123456",
                                 optional: true,
                                 conflicting_options: [ :version_name ],
                                 conflict_block: proc do |value|
                                   UI.user_error!("You can't use 'id' and 'name' options in one run")
                                 end,
                                 verify_block: proc do |value|
                                   UI.user_error!("Empty verison id") unless !value.nil? and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :version_name,
                                 description: "JIRA version name",
                                 is_string: false,
                                 optional: true,
                                 conflicting_options: [:version_id],
                                 conflict_block: proc do |value|
                                    UI.user_error!("You can't use 'id' and 'name' options in one run")
                                 end,
                                 verify_block: proc do |value|
                                    UI.user_error!("Empty verison name") unless !value.nil? and !value.empty?
                                 end)
  ]
end

.description ⇒ Object 



68
69
70
 
# File 'lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb', line 68

def self.description
  "Return link to JIRA release report."
end

.details ⇒ Object 



72
73
74
 
# File 'lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb', line 72

def self.details
  "Return link to JIRA release report. Link looks like https://JIRA_SITE/projects/PROJ/versions/VERSION/tab/release-report-all-issues"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


161
162
163
 
# File 'lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb', line 161

def self.is_supported?(platform)
  true
end

.output ⇒ Object 



147
148
149
150
151
 
# File 'lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb', line 147

def self.output
  [
    ['JIRA_UTIL_GET_JIRA_RELEASE_REPORT_LINK_RESULT', 'JIRA release report link']
  ]
end

.return_value ⇒ Object 



153
154
155
 
# File 'lib/fastlane/plugin/jira_util/actions/get_jira_release_report_link.rb', line 153

def self.return_value
  'JIRA release report link'
end

.run(params) ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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_util/actions/get_jira_release_report_link.rb', line 8

def self.run(params)
  Actions.verify_gem!('jira-ruby')
  require 'jira-ruby'

  site         = params[:url]
  context_path = ""
  auth_type    = :basic
  username     = params[:username]
  password     = params[:password]
  project_name = params[:project_name]
  project_id   = params[:project_id]
  released     = true

  options = {
    username:     username,
    password:     password,
    site:         site,
    context_path: context_path,
    auth_type:    auth_type,
    read_timeout: 120
  }

  client = JIRA::Client.new(options)

  unless project_name.nil?
    project = client.Project.find(project_name)
    project_id = project.key
  end
  raise ArgumentError.new("Project not found.") if project_id.nil?

  version = nil
  if !params[:version_id].nil?
    version = project.versions.find { |version| version.id == params[:version_id] }
  elsif !params[:version_name].nil?
    version = project.versions.find { |version| version.name == params[:version_name] }
  end

  raise ArgumentError.new("Version not found.") if version.nil?

  version_id = version.id

  raise ArgumentError.new("Version has empty id.") if version_id.nil?

  release_report_path = "/projects/#{project.key}/versions/#{version_id}/tab/release-report-all-issues"
  release_report_link = URI.join(site, release_report_path).to_s

  Actions.lane_context[SharedValues::JIRA_UTIL_GET_JIRA_RELEASE_REPORT_LINK_RESULT] = release_report_link
  release_report_link
rescue RuntimeError
  UI.user_error!("#{$!}")
  nil
rescue JIRA::HTTPError
  UI.user_error!("Failed to find JIRA version: #{$!.response.body}")
  nil
end