Class: Fastlane::Actions::UpdateJiraVersionAction

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

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



205
206
207
 
# File 'lib/fastlane/plugin/jira_util/actions/update_jira_version.rb', line 205

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

.available_options ⇒ Object 



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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/fastlane/plugin/jira_util/actions/update_jira_version.rb', line 102

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: :id,
                                 description: "JIRA version id. E.g. 123456",
                                 optional: true,
                                 conflicting_options: [ :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 and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :name,
                                 description: "JIRA version name",
                                 is_string: false,
                                 optional: true,
                                 conflicting_options: [: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 and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :new_name,
                                 optional: true,
                                 description: "New name for the version. E.g. 1.0.0",
                                 verify_block: proc do |value|
                                   UI.user_error!("new_name is empty") unless value and !value.empty?
                                 end),
    FastlaneCore::ConfigItem.new(key: :description,
                                 optional: true,
                                 description: "The description of the JIRA project version"),
    FastlaneCore::ConfigItem.new(key: :archived,
                                 description: "Whether the version should be archived",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :released,
                                 description: "Whether the version should be released",
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :start_date,
                                 description: "The date this version will start on",
                                 type: String,
                                 is_string: true,
                                 optional: true)
  ]
end

.description ⇒ Object 



94
95
96
 
# File 'lib/fastlane/plugin/jira_util/actions/update_jira_version.rb', line 94

def self.description
  "Creates a new version in your JIRA project"
end

.details ⇒ Object 



98
99
100
 
# File 'lib/fastlane/plugin/jira_util/actions/update_jira_version.rb', line 98

def self.details
  "Use this action to create a new version in JIRA"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


209
210
211
 
# File 'lib/fastlane/plugin/jira_util/actions/update_jira_version.rb', line 209

def self.is_supported?(platform)
  true
end

.output ⇒ Object 



195
196
197
198
199
 
# File 'lib/fastlane/plugin/jira_util/actions/update_jira_version.rb', line 195

def self.output
  [
    ['JIRA_UTIL_UPDATE_JIRA_VERSION_VERSION_ID', 'The id for the updated JIRA project version']
  ]
end

.return_value ⇒ Object 



201
202
203
 
# File 'lib/fastlane/plugin/jira_util/actions/update_jira_version.rb', line 201

def self.return_value
  'The id for the updated JIRA project version'
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/fastlane/plugin/jira_util/actions/update_jira_version.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]
  name         = params[:name]
  new_name     = params[:new_name]
  description  = params[:description]
  archived     = params[:archived]
  released     = params[:released]
  start_date   = params[:start_date]

  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.id
  end
  raise ArgumentError.new('Project not found') if project_id.nil?

  if start_date.nil?
    start_date = Date.today.to_s
  end

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

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

  version_fields = {
  }

  unless new_name.nil?
    version_fields['name'] = new_name
  end

  unless description.nil?
    version_fields['description'] = description
  end

  unless archived.nil?
    version_fields['archived'] = archived
  end

  unless released.nil?
    version_fields['released'] = released
  end

  unless start_date.nil?
    version_fields['startDate'] = start_date
  end

  raise ArgumentError.new('Nothng to update') if version_fields.empty?

  version.save!(version_fields)

  Actions.lane_context[SharedValues::JIRA_UTIL_UPDATE_JIRA_VERSION_VERSION_ID] = version.id
  version.id
rescue
  UI.user_error!("Failed to update JIRA version: #{$!.response.body}")
  false
end