Class: Fastlane::Actions::JiraAction

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

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, deprecated_notes, details, lane_context, method_missing, other_action, output, return_type, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authorsObject


82
83
84
# File 'fastlane/lib/fastlane/actions/jira.rb', line 82

def self.authors
  ["iAmChrisTruman"]
end

.available_optionsObject


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
# File 'fastlane/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: :context_path,
                                env_name: "FL_JIRA_CONTEXT_PATH",
                                description: "Appends to the url (ex: \"/jira\")",
                                optional: true,
                                default_value: ""),
    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",
                                 sensitive: true,
                                 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

.categoryObject


110
111
112
# File 'fastlane/lib/fastlane/actions/jira.rb', line 110

def self.category
  :misc
end

.descriptionObject


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

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

.example_codeObject


90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'fastlane/lib/fastlane/actions/jira.rb', line 90

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"
    )',
    'jira(
      url: "https://yourserverdomain.com",
      context_path: "/jira",
      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:


86
87
88
# File 'fastlane/lib/fastlane/actions/jira.rb', line 86

def self.is_supported?(platform)
  true
end

.return_valueObject


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

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

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

  site         = params[:url]
  auth_type    = :basic
  context_path = params[:context_path]
  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