Class: Fastlane::Actions::JiraCommentAction

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

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



71
72
73
 
# File 'lib/fastlane/plugin/jira_issues_release_notes/actions/jira_comment_action.rb', line 71

def self.authors
  ["Erick Martins"]
end

.available_options ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/fastlane/plugin/jira_issues_release_notes/actions/jira_comment_action.rb', line 84

def self.available_options
  conflict_extraction_method = Proc.new do |other|
    UI.user_error! "Unexpected conflict with option #{other}" unless [:extract_from_branch, :tag_prefix].include?(other)
  end

  conflict_comment = Proc.new do |other|
    UI.user_error! "Unexpected conflict with option #{other}" unless [:comment_block, :comment].include?(other)
  end

  [
    FastlaneCore::ConfigItem.new(
      key: :tag_prefix,
      description: "Match parameter of git describe. See man page of git describe for more info",
      optional: true,
      conflicting_options: [:extract_from_branch],
      conflict_block: conflict_extraction_method
    ),
    FastlaneCore::ConfigItem.new(
      key: :ticket_prefix,
      env_name: 'FL_FIND_TICKETS_MATCHING',
      description:  'regex to extract ticket numbers',
      default_value: '[A-Z]+',
      optional: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :tag_version_match,
      description: "To parse version number from tag name",
      default_value: '\d+\.\d+\.\d+',
      optional: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :extract_from_branch,
      description: "If true it will search for jira issue key in the current branch name. In this case do NOT set :tag_prefix",
      conflicting_options: [:tag_prefix],
      conflict_block: conflict_extraction_method,
      default_value: false,
      optional: true,
      type: Boolean
    ),
    FastlaneCore::ConfigItem.new(
      key: :comment,
      description: 'Comment to add to the ticket',
      conflicting_options: [:comment_block],
      conflict_block: conflict_comment,
      optional: true,
      type: String,
    ),
    FastlaneCore::ConfigItem.new(
      key: :comment_block,
      description: 'Comment block to add to the ticket',
      conflicting_options: [:comment],
      optional: true,
      conflict_block: conflict_comment,
      type: Hash,
    ),

    # Jira Client options
    FastlaneCore::ConfigItem.new(
      key: :username,
      env_name: 'FL_JIRA_USERNAME',
      description:  'Jira user',
      optional: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :password,
      env_name: 'FL_JIRA_PASSWORD',
      description:  'Jira user',
      optional: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :host,
      env_name: 'FL_JIRA_HOST',
      description:  'Jira location',
      optional: false
    ),
    FastlaneCore::ConfigItem.new(
      key: :api_version,
      env_name: 'FL_JIRA_API_VERSION',
      description:  'Jira api version',
      default_value: '3',
      optional: true,
    ),
    FastlaneCore::ConfigItem.new(
      key: :context_path,
      env_name: 'FL_JIRA_CONTEXT_PATH',
      description:  'Jira context path',
      optional: true,
      default_value: ''
    ),
    FastlaneCore::ConfigItem.new(
      key: :disable_ssl_verification,
      env_name: 'FL_JIRA_DISABLE_SSL_VERIFICATION',
      description:  'Jira SSL Verification mode',
      optional: true,
      default_value: false,
      type: Boolean
    ),
    FastlaneCore::ConfigItem.new(
      key: :debug,
      description: "True if you want to log out a debug info",
      default_value: false,
      type: Boolean,
      optional: true
    )
  ]
end

.description ⇒ Object 



67
68
69
 
# File 'lib/fastlane/plugin/jira_issues_release_notes/actions/jira_comment_action.rb', line 67

def self.description
  "It generates a release note based on the issues keys found in branch name and descriptions found in the commits"
end

.details ⇒ Object 



79
80
81
82
 
# File 'lib/fastlane/plugin/jira_issues_release_notes/actions/jira_comment_action.rb', line 79

def self.details
  # Optional:
  "It generates a release note based on the issues keys found in branch name and descriptions found in the commits"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
194
195
196
197
 
# File 'lib/fastlane/plugin/jira_issues_release_notes/actions/jira_comment_action.rb', line 191

def self.is_supported?(platform)
  # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
  # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
  #
  # [:ios, :mac, :android].include?(platform)
  true
end

.return_value ⇒ Object 



75
76
77
 
# File 'lib/fastlane/plugin/jira_issues_release_notes/actions/jira_comment_action.rb', line 75

def self.return_value
  "boolean value"
end

.run(params) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
 
# File 'lib/fastlane/plugin/jira_issues_release_notes/actions/jira_comment_action.rb', line 15

def self.run(params)
  api_version = params[:api_version].to_i

  UI.user_error! "Comments block are only available from api version 3 or earlier" if api_version < 3 and params[:comment_block]

  @jira_helper = Helper::JiraIssuesReleaseNotesHelper.initialize_jira(
    host: params[:host],
    api_version: api_version,
    username: params[:username],
    password: params[:password],
    context_path: params[:context_path],
    disable_ssl_verification: params[:disable_ssl_verification]
  )

  issues = []
  if params[:extract_from_branch] then
    branch = other_action.git_branch
    ticket_key = Helper::JiraIssuesReleaseNotesHelper.extract_key_from_branch(
      branch: branch,
      ticket_prefix: params[:ticket_prefix]
    )

    unless ticket_key
      UI.error "Could not extract issue key from branch #{branch}" 
      false
    end 

    issues = @jira_helper.get(keys: [ticket_key])
  else

    issue_key_regex = Regexp.new("(#{params[:ticket_prefix]}-\\d+)")

    issues = Helper::JiraIssuesReleaseNotesHelper.get_issues_from_commit_after_latest_tag(
      tag_regex: params[:tag_prefix],
      tag_version_match: params[:tag_version_match],
      issue_key_regex: issue_key_regex,
      debug: params[:debug]
    )
  end

  unless !issues.empty?
    UI.error "No issue could be matched with (#{params[:ticket_prefix]}-\\d+)" 
    false
  end 

  @jira_helper.add_comment(
    comment: params[:comment_block] || params[:comment],
    issues: issues
  )

end