Class: Fastlane::Actions::JiraAction

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

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, details, lane_context, method_missing, other_action, output, sample_return_value, sh, step_text

Class Method Details

.authors ⇒ Object 



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

def self.authors
  ["iAmChrisTruman"]
end

.available_options ⇒ Object 



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

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

.category ⇒ Object 



96
97
98
 
# File 'lib/fastlane/actions/jira.rb', line 96

def self.category
  :misc
end

.description ⇒ Object 



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

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

.example_code ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/fastlane/actions/jira.rb', line 84

def self.example_code
  [
    'jira(
      url: "https://bugs.yourdomain.com",
      username: "Your username",
      password: "Your password",
      ticket_id: "Ticket ID, i.e. IOS-123",
      comment_text: "Text to post as a comment"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


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

def self.is_supported?(platform)
  true
end

.return_value ⇒ Object 



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

def self.return_value
end

.run(params) ⇒ Object 



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

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]
  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