Class: Fastlane::Actions::BuildkiteAnnotateAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_annotate_action.rb

Documentation collapse

Class Method Summary collapse

Class Method Details

.authors ⇒ Object 



76
77
78
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_annotate_action.rb', line 76

def self.authors
  ['Automattic']
end

.available_options ⇒ Object 



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
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_annotate_action.rb', line 43

def self.available_options
  [
    FastlaneCore::ConfigItem.new(
      key: :context,
      env_name: 'BUILDKITE_ANNOTATION_CONTEXT',
      description: 'The context of the annotation used to differentiate this annotation from others',
      type: String,
      optional: true
    ),
    FastlaneCore::ConfigItem.new(
      key: :style,
      env_name: 'BUILDKITE_ANNOTATION_STYLE',
      description: 'The style of the annotation (`success`, `info`, `warning` or `error`)',
      type: String,
      optional: true,
      verify_block: proc do |value|
        valid_values = %w[success info warning error]
        next if value.nil? || valid_values.include?(value)

        UI.user_error!("Invalid value `#{value}` for parameter `style`. Valid values are: #{valid_values.join(', ')}")
      end
    ),
    FastlaneCore::ConfigItem.new(
      key: :message,
      description: 'The message to use in the new annotation. Supports GFM-Flavored Markdown. ' \
      + 'If message is nil, any existing annotation with the provided context will be deleted',
      type: String,
      optional: true,
      default_value: nil # nil message = delete existing annotation if any
    ),
  ]
end

.description ⇒ Object 



28
29
30
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_annotate_action.rb', line 28

def self.description
  'Add or remove annotations to the current Buildkite build'
end

.details ⇒ Object 



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_annotate_action.rb', line 32

def self.details
  <<~DETAILS
    Add or remove annotations to the current Buildkite build.

    Has to be run on a CI job (where a `buildkite-agent` is running), e.g. typically by a lane
    that is triggered as part of a Buildkite CI step.

    See https://buildkite.com/docs/agent/v3/cli-annotate
  DETAILS
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_annotate_action.rb', line 80

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_annotate_action.rb', line 4

def self.run(params)
  message = params[:message]
  context = params[:context]
  style = params[:style]

  if message.nil?
    # Delete an annotation, but swallow the error if the annotation didn't exist — to avoid having
    # this action failing or printing a red log for no good reason — hence the `|| true`
    ctx_param = "--context #{context.shellescape}" unless context.nil?
    sh("buildkite-agent annotation remove #{ctx_param} || true")
  else
    # Add new annotation using `buildkite-agent`
    extra_params = {
      context: context,
      style: style
    }.compact.flat_map { |k, v| ["--#{k}", v] }
    sh('buildkite-agent', 'annotate', *extra_params, params[:message])
  end
end