Class: Fastlane::Actions::JiraAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/jira.rb

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, details, method_missing, other_action, sh, step_text

Class Method Details

.authorsObject



80
81
82
# File 'lib/fastlane/actions/jira.rb', line 80

def self.authors
  ["iAmChrisTruman"]
end

.available_optionsObject



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
# File 'lib/fastlane/actions/jira.rb', line 39

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :url,
                                env_name: "FL_JIRA_SITE",
                                description: "URL for Jira instance",
                                 verify_block: proc do |value|
                                   UI.user_error!("No url for Jira given, pass using `url: 'url'`") if value.to_s.length == 0
                                 end),
    FastlaneCore::ConfigItem.new(key: :username,
                                 env_name: "FL_JIRA_USERNAME",
                                 description: "Username for JIRA instance",
                                 verify_block: proc do |value|
                                   UI.user_error!("No username") if value.to_s.length == 0
                                 end),
    FastlaneCore::ConfigItem.new(key: :password,
                                 env_name: "FL_JIRA_PASSWORD",
                                 description: "Password for Jira",
                                 verify_block: proc do |value|
                                   UI.user_error!("No password") if value.to_s.length == 0
                                 end),
    FastlaneCore::ConfigItem.new(key: :ticket_id,
                                 env_name: "FL_JIRA_TICKET_ID",
                                 description: "Ticket ID for Jira, i.e. IOS-123",
                                 verify_block: proc do |value|
                                   UI.user_error!("No Ticket specified") if value.to_s.length == 0
                                 end),
    FastlaneCore::ConfigItem.new(key: :comment_text,
                                 env_name: "FL_JIRA_COMMENT_TEXT",
                                 description: "Text to add to the ticket as a comment",
                                 verify_block: proc do |value|
                                   UI.user_error!("No comment specified") if value.to_s.length == 0
                                 end)
  ]
end

.descriptionObject



35
36
37
# File 'lib/fastlane/actions/jira.rb', line 35

def self.description
  "Leave a comment on JIRA tickets"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean)


84
85
86
# File 'lib/fastlane/actions/jira.rb', line 84

def self.is_supported?(platform)
  true
end

.outputObject



74
75
# File 'lib/fastlane/actions/jira.rb', line 74

def self.output
end

.return_valueObject



77
78
# File 'lib/fastlane/actions/jira.rb', line 77

def self.return_value
end

.run(params) ⇒ Object



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'lib/fastlane/actions/jira.rb', line 5

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

  site         = params[:url]
  context_path = ""
  auth_type    = :basic
  username     = params[:username]
  password     = params[:password]
  ticket_id    = params[:ticket_id]
  comment_text = params[:comment_text]

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

  client = JIRA::Client.new(options)
  issue = client.Issue.find(ticket_id)
  comment = issue.comments.build
  comment.save({ 'body' => comment_text })
end