Class: Fastlane::Actions::JiraTicketAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



28
29
30
 
# File 'lib/fastlane/plugin/jira_ticket/actions/jira_ticket_action.rb', line 28

def self.authors
  ["Dorian Cheignon"]
end

.available_options ⇒ Object 



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
 
# File 'lib/fastlane/plugin/jira_ticket/actions/jira_ticket_action.rb', line 41

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",
                       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),
  ]
end

.description ⇒ Object 



24
25
26
 
# File 'lib/fastlane/plugin/jira_ticket/actions/jira_ticket_action.rb', line 24

def self.description
  "get ticket in jira board"
end

.details ⇒ Object 



36
37
38
39
 
# File 'lib/fastlane/plugin/jira_ticket/actions/jira_ticket_action.rb', line 36

def self.details
  # Optional:
  "you can accest to your ticket over this plugin"
end

.example_code ⇒ Object 



71
72
73
74
75
 
# File 'lib/fastlane/plugin/jira_ticket/actions/jira_ticket_action.rb', line 71

def self.example_code
  [
    "jira_ticket(username: *******, password: **********, url: 'https://your-jira-url.com', ticket_id: 'XXXX')"
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/fastlane/plugin/jira_ticket/actions/jira_ticket_action.rb', line 77

def self.is_supported?(platform)
  true
end

.return_value ⇒ Object 



32
33
34
 
# File 'lib/fastlane/plugin/jira_ticket/actions/jira_ticket_action.rb', line 32

def self.return_value
  # If your method provides a return value, you can describe here what it does
end

.run(params) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/fastlane/plugin/jira_ticket/actions/jira_ticket_action.rb', line 7

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

  client = JIRA::Client.new(
    username:     params[:username],
    password:     params[:password],
    site:         params[:url],
    context_path: '',
    auth_type:    :basic
  )
      
  issue = client.Issue.find(params[:ticket_id])
      
  return issue
end