class Fastlane::Actions::CreateJiraVersionAction
Public Class Methods
available_options()
click to toggle source
# File lib/fastlane/plugin/jira_util/actions/create_jira_version.rb, line 92 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: :name, is_string: true, optional: true, description: "The name of the version. E.g. 1.0.0", verify_block: proc do |value| UI.user_error!("No version name given, pass using `name: '1.0.0'`") unless value and !value.empty? end), FastlaneCore::ConfigItem.new(key: :description, is_string: true, optional: true, description: "The description of the JIRA project version", default_value: ''), FastlaneCore::ConfigItem.new(key: :archived, is_string: false, optional: true, description: "Whether the version should be archived", default_value: false), FastlaneCore::ConfigItem.new(key: :released, is_string: false, optional: true, description: "Whether the version should be released", default_value: false), FastlaneCore::ConfigItem.new(key: :start_date, is_string: true, optional: true, description: "The date this version will start on", default_value: Date.today.to_s), FastlaneCore::ConfigItem.new(key: :update_if_exists, is_string: false, optional: true, description: "If version with 'name' exists it will be updated", default_value: false), ] end
description()
click to toggle source
@!group Documentation
# File lib/fastlane/plugin/jira_util/actions/create_jira_version.rb, line 84 def self.description "Creates a new version in your JIRA project" end
details()
click to toggle source
# File lib/fastlane/plugin/jira_util/actions/create_jira_version.rb, line 88 def self.details "Use this action to create a new version in JIRA" end
is_supported?(platform)
click to toggle source
# File lib/fastlane/plugin/jira_util/actions/create_jira_version.rb, line 188 def self.is_supported?(platform) true end
output()
click to toggle source
# File lib/fastlane/plugin/jira_util/actions/create_jira_version.rb, line 174 def self.output [ ['JIRA_UTIL_CREATE_JIRA_VERSION_VERSION_ID', 'The versionId for the newly created JIRA project version'] ] end
return_value()
click to toggle source
# File lib/fastlane/plugin/jira_util/actions/create_jira_version.rb, line 180 def self.return_value 'The versionId for the newly create JIRA project version' end
run(params)
click to toggle source
# File lib/fastlane/plugin/jira_util/actions/create_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] description = params[:description] archived = params[:archived] released = params[:released] start_date = params[:start_date] update_if_exists = params[:update_if_exists] 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 = project.versions.find { |version| version.name == name } if version.nil? version = client.Version.build version.save!({ "description" => description, "name" => name, "archived" => archived, "released" => released, "startDate" => start_date, "projectId" => project_id }) elsif update_if_exists version.save!({ "description" => description, "archived" => archived, "released" => released, "startDate" => start_date, }) else raise RuntimeError.new("Version with such name already exists.") end version.fetch Actions.lane_context[SharedValues::JIRA_UTIL_CREATE_JIRA_VERSION_VERSION_ID] = version.id version.id rescue JIRA::HTTPError UI.user_error!("Failed to create JIRA issue: #{$!.response.body}") nil rescue UI.user_error!("Failed to create JIRA issue: #{$!}") nil end