buildkite-builder 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d0f3ff0ed7f9f3733ecf88da93150959025b484bdae546237b96a3ace1ac46e
-  data.tar.gz: 14abc08e2a993a622c937b8822cbdc01b467883bbeca37f598185a7f21293a43
+  metadata.gz: 0de0ca71b799a2ae9a8e7c58a853ba4b77fef220b333f5f4d1d790e79c93af3e
+  data.tar.gz: 633bd86958bc6155e30be2fcf62f1ca12b6c6d9c2eb96a5698f2dadaa020b036
 SHA512:
-  metadata.gz: 9263c2d4f11e8313e79a567a2efe2a5bfeeee06fa3b476763c550f092f6285413bd9a859875e598b457484b870a4a738ee5ac9d90c2fe7334c5856ce755d4891
-  data.tar.gz: 6d44131cc78e0a56c5aa859419d3e5386bee8b02664b999db93eacccb9f51028250ab80fd358226c4e5f5b5defa26a8ed00aa0a8a9cb9a3304681845462e79ee
+  metadata.gz: 37ad92f7df9fa06f81423968c4c040cb629a39a7bf00cd48fc53bce1d8439f5c551cdbe80c9efba92954592dad696a957d144c4da26a9ba8b2c1747528672ff7
+  data.tar.gz: e63a9f02c24f60f27e2bb23d71ee24543349f2a860810b4fb7e1a21e3b615fd96054acf72f04902632bccbd02274dc58cf5d225b5cac538693ed6d7439b7bced

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+### 4.2.0
+* Add shared global templates
+
+### 4.1.2
+* Raise error with stderr/stdout message when `buildkite-agent` command failed while using bang commands (`artifact!`, `annotate!`, `pipeline!`, and `meta_data!`)
+* Add `signal_reason` as an automatic retry option
+
+### 4.1.1
+* Fix `PluginManager`'s error message when plugin was not registered
+
+### 4.1.0
+* Remove `skip` step since it's only mimicing `command` step with a skip.
+
+### 4.0.0
+* Remove `subpipeline` since it's not a Buildkite standard.
+* Refactor template handling
+* Simplify `group` step implementation
+
+### 3.9.0
+* Create a `Plugins` extension to take care named plugins from the plugin manager.
+
+### 3.8.1...3.8.3
+* Expose extension manager to be accessible in dsl
+* Removes an extra definition of `attr_reader :extensions` in pipeline
+* Allow `group` steps to be able to use extension's dsl methods
+* Show buildkite builder version at the beginning of the command
+
+### 3.8.0
+* Extensions can now take block as argument [example](https://github.com/Gusto/buildkite-builder/blob/v3.8.0/.buildkite/pipelines/showcase/pipeline.rb#L6-L13)
+
 ## 3.6.0
 * `Buildkite::Pipelines::Command#run` now uses `Open3.capture3` to run system commands, and accepts an optional arg `capture`. When `capture` is true, it returns the stdout of the command. `capture` is true for the meta_data subcommands `get` and `keys` and for the artifact subcommands `shasum` and `search`.
 

data/VERSION

@@ -1 +1 @@
-4.1.1
+4.2.0

data/lib/buildkite/builder/loaders/templates.rb

@@ -9,16 +9,27 @@ module Buildkite
         TEMPLATES_PATH = Pathname.new('templates').freeze
 
         def load
-          return unless templates_path.directory?
+          load_from_path(global_path)
+          load_from_path(pipeline_path)
+        end
+
+        private
+
+        def load_from_path(path)
+          return unless path.directory?
 
-          templates_path.children.sort.each do |file|
+          path.children.sort.each do |file|
             add(file.basename('.rb'), load_definition(file, Definition::Template))
           end
         end
 
-        def templates_path
+        def pipeline_path
           root.join(TEMPLATES_PATH)
         end
+
+        def global_path
+          buildkite_path.join(TEMPLATES_PATH)
+        end
       end
     end
   end

data/lib/buildkite/pipelines/command.rb

@@ -5,6 +5,8 @@ require 'open3'
 module Buildkite
   module Pipelines
     class Command
+      class CommandFailedError < StandardError; end
+
       BIN_PATH = 'buildkite-agent'
       COMMANDS = %w(
         pipeline
@@ -14,36 +16,38 @@ module Buildkite
       )
 
       class << self
-        def pipeline(subcommand, *args)
-          new(:pipeline, subcommand, *args).run
+        def pipeline(subcommand, *args, exception: false)
+          new(:pipeline, subcommand, *args).run(exception: exception)
         end
 
-        def artifact(subcommand, *args)
+        def artifact(subcommand, *args, exception: false)
           capture = case subcommand.to_s
           when 'shasum', 'search' then true
           else false
           end
 
-          new(:artifact, subcommand, *args).run(capture: capture)
+          new(:artifact, subcommand, *args).run(capture: capture, exception: exception)
         end
 
-        def annotate(body, *args)
-          new(:annotate, body, *args).run
+        def annotate(body, *args, exception: false)
+          new(:annotate, body, *args).run(exception: exception)
         end
 
-        def meta_data(subcommand, *args)
+        def meta_data(subcommand, *args, exception: false)
           capture = case subcommand.to_s
           when 'get', 'keys' then true
           else false
           end
 
-          new(:'meta-data', subcommand, *args).run(capture: capture)
+          new(:'meta-data', subcommand, *args).run(capture: capture, exception: exception)
         end
       end
 
       COMMANDS.each do |command|
         define_singleton_method("#{command}!") do |*args|
-          abort unless public_send(command, *args)
+          public_send(command, *args, exception: true)
+        rescue CommandFailedError => e
+          abort e.message
         end
       end
 
@@ -54,9 +58,17 @@ module Buildkite
         @args = transform_args(args)
       end
 
-      def run(capture: false)
-        stdout, _, status = Open3.capture3(*to_a)
-        capture ? stdout : status.success?
+      def run(capture: false, exception: false)
+        stdout, stderr, status = Open3.capture3(*to_a)
+        if capture
+          stdout
+        elsif status.success?
+          true
+        elsif exception
+          raise CommandFailedError, "#{stdout}\n#{stderr}"
+        else
+          false
+        end
       end
 
       private

data/lib/buildkite/pipelines/helpers/retry.rb

@@ -4,15 +4,36 @@ module Buildkite
   module Pipelines
     module Helpers
       module Retry
-        def automatic_retry_on(exit_status:, limit:)
+        def automatic_retry_on(exit_status: nil, limit: nil, signal_reason: nil)
+          raise 'limit must set for `automatic_retry_on`.' unless limit
+
+          if exit_status.nil? && signal_reason.nil?
+            raise 'signal_reason or exit_status must set for `automatic_retry_on`.'
+          end
+
           retry_value = get(:retry) || set(:retry, {})
 
           unless retry_value[:automatic].is_a?(Array)
             retry_value[:automatic] = []
           end
 
-          retry_value[:automatic].delete_if { |rule| rule[:exit_status] == exit_status }
-          retry_value[:automatic].push(exit_status: exit_status, limit: limit)
+          automatic_options = { limit: limit }
+
+          if exit_status && signal_reason
+            retry_value[:automatic].delete_if do |rule|
+              rule[:exit_status] == exit_status && rule[:signal_reason] == signal_reason
+            end
+            automatic_options[:exit_status] = exit_status
+            automatic_options[:signal_reason] = signal_reason
+          elsif exit_status
+            retry_value[:automatic].delete_if { |rule| rule[:exit_status] == exit_status }
+            automatic_options[:exit_status] = exit_status
+          elsif signal_reason
+            retry_value[:automatic].delete_if { |rule| rule[:signal_reason] == signal_reason }
+            automatic_options[:signal_reason] = signal_reason
+          end
+
+          retry_value[:automatic].push(automatic_options)
         end
 
         def automatic_retry(enabled)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.