buildkite-builder 4.17.0 → 4.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5e401666ddc2c622b9b7e08fe67af7c05a4604227372c7cd1030c372ad115d9
-  data.tar.gz: b692d1c23684daad5d38017843b015e7c3a3ad58eae8941311225bc7723b457c
+  metadata.gz: 766b0ac1d07fc726b376e905fbfaa30864055c458bd0f3190247ec56a853768c
+  data.tar.gz: 4e79fe7cc6b1913afcd311ea96349242653f45ce0b541e7cb452dcb9e5366460
 SHA512:
-  metadata.gz: 0ecd57119c0226f3c40fdc7523d3cd9e742b6b1e63499aca292bede84c5a65034204d500202aeb9323e24bfd8e1e3705a97924f91be15e925765ff0356f7cf7e
-  data.tar.gz: b560a84cc98ed6e4bdf1d8d01f8db4445138fd0b34ccef8e78276d6eba4ce35884e232a1811e84cdfc8dff7eb3902931b3150be48f0d6695c483714264ad6409
+  metadata.gz: 7313796c22a45884e1120ef293279f3473eb17da52e5c93bd71c5cc8c5514725fe0428ebe25a74b2adc728634bbeb256afc81e2625e2f4ae90d4f4ae4b7d92fc
+  data.tar.gz: 521ce5fdfeace7b5f23049cbf5e15df6a195f31d8aa7f71bbd856a2daa22a31ed9b5de405c5c330d1bb4b2696111c572d9bf3281dee72de403ee9ca7c365f51b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 4.19.0
+* Support build matrix.
+
+### 4.18.0
+* Support template definition within extensions.
+
 ### 4.17.0
 * Add support for `notify` attribute in command steps.
 

data/README.md

@@ -27,9 +27,17 @@ As with every Buildkite pipeline, you'll need to define the initial pipeline ste
 ```yaml
 steps:
   - label: ":toolbox:"
+    key: "buildkite-builder"
+    retry:
+      automatic:
+        - exit_status: -1 # Agent was lost
+          limit: 2
+        - exit_status: 255 # Forced agent shutdown
+          limit: 2
     plugins:
-      - docker#v3.7.0:
-          image: gusto/buildkite-builder:2.1.0
+      - docker#v5.12.0:
+          image: "gusto/buildkite-builder:4.13.0"
+          mount-buildkite-agent: true
           propagate-environment: true
 ```
 
@@ -135,6 +143,61 @@ Buildkite::Builder.pipeline do
 end
 ```
 
+### Extensions
+
+Extensions provide additional flexibility to run code and encapsulate reusable patterns in your pipelines. Think of extensions as Ruby modules that let you define custom DSL, step templates, and shared logic that can be used across multiple pipelines.
+
+Extensions are useful when you want to standardize how certain steps are defined, or when you want to use or share complex logic (like deployment, notifications, or test orchestration).
+
+`.buildkite/pipelines/foobar-widget/extensions/deploy_extension.rb`
+
+```ruby
+class DeployExtension < Buildkite::Builder::Extension
+  dsl do
+    def deploy_step(&block)
+      command(:deploy, &block)
+    end
+  end
+end
+```
+
+`.buildkite/pipelines/foobar-widget/pipeline.rb`
+
+```ruby
+Buildkite::Builder.pipeline do
+  deploy_step do
+    label "Deploy to production (EU)"
+    command "bundle exec deploy --env production --region eu"
+  end
+end
+```
+
+#### Extension Templates
+
+Extensions can also provide multiple templates for different scenarios:
+
+```ruby
+class TestExtension < Buildkite::Builder::Extension
+  template :default do
+    command "bundle exec rspec"
+  end
+
+  template :rubocop do
+    command "bundle exec rubocop"
+  end
+end
+```
+
+And used like this in the pipeline file:
+
+```ruby
+command(TestExtension) # Uses the default template
+
+command(TestExtension.template(:rubocop)) do
+  label "Custom Rubocop label"
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/VERSION

@@ -1 +1 @@
-4.17.0
+4.19.0

data/bin/release

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+version=$(<VERSION)
+version=$(echo "$version" | xargs) # Trim whitespace
+
+echo "💎 Build and push gem"
+GEM_HOST_API_KEY=$(buildkite-agent secret get RUBYGEMS_API_TOKEN) docker buildx build --secret id=gem-host-api-key,env=GEM_HOST_API_KEY --target gem .
+
+echo "🐳 Logging in to DockerHub"
+buildkite-agent secret get DOCKERHUB_PASSWORD | docker login --username zpadmin --password-stdin
+
+echo "🔨 Building and pushing docker image for release of Buildkite Builder version $version"
+docker build --tag=gusto/buildkite-builder:"$version" \
+  --target release \
+  --platform linux/x86_64 \
+  --build-arg version="$version" \
+  --push .
+
+echo "✅ Done!"

data/lib/buildkite/builder/extension.rb

@@ -3,11 +3,26 @@
 module Buildkite
   module Builder
     class Extension
+
       class << self
         def dsl(&block)
           @dsl = Module.new(&block) if block_given?
           @dsl
         end
+
+        def template(name = :default, &block)
+          name = name.to_s
+
+          if block_given? && templates.key?(name)
+            raise ArgumentError, "Template #{name} already registered in #{self.name}"
+          end
+
+          templates[name] ||= ExtensionTemplate.new(self, name, block)
+        end
+
+        def templates
+          @templates ||= {}
+        end
       end
 
       attr_reader :context

data/lib/buildkite/builder/extension_template.rb

@@ -0,0 +1,13 @@
+module Buildkite
+  module Builder
+    class ExtensionTemplate
+      attr_reader :extension_class, :name, :block
+
+      def initialize(extension_class, name, block)
+        @extension_class = extension_class
+        @name = name
+        @block = block
+      end
+    end
+  end
+end

data/lib/buildkite/builder/extensions/steps.rb

@@ -10,7 +10,7 @@ module Buildkite
         end
 
         def build_step(step_class, template_name, **args, &block)
-          template = @templates.find(template_name)
+          template = find_template(template_name)
 
           step_class.new(**args).tap do |step|
             step.process(template) if template
@@ -35,6 +35,25 @@ module Buildkite
           @current_group = nil
         end
 
+        private
+
+        def find_template(template_name)
+          case template_name
+          when Buildkite::Builder::ExtensionTemplate
+            template_name.block
+          when Class
+            unless context.extensions.all.include?(template_name)
+              raise ArgumentError, "#{template_name} extension is not registered"
+            end
+
+            if template_name < Buildkite::Builder::Extension
+              find_template(context.extensions.find(template_name).class.template)
+            end
+          else
+            @templates.find(template_name)
+          end
+        end
+
         dsl do
           def group(&block)
             context.extensions.find(Steps).with_group(Pipelines::Steps::Group.new(context), &block)

data/lib/buildkite/builder.rb

@@ -10,6 +10,7 @@ module Buildkite
     autoload :Data, File.expand_path('builder/data', __dir__)
     autoload :Dsl, File.expand_path('builder/dsl', __dir__)
     autoload :Extension, File.expand_path('builder/extension', __dir__)
+    autoload :ExtensionTemplate, File.expand_path('builder/extension_template', __dir__)
     autoload :ExtensionManager, File.expand_path('builder/extension_manager', __dir__)
     autoload :Extensions, File.expand_path('builder/extensions', __dir__)
     autoload :Loaders, File.expand_path('builder/loaders', __dir__)

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Buildkite
+  module Pipelines
+    module Helpers
+      module Matrix
+        def matrix(value = nil, setup: nil)
+          if value.nil? && setup.nil?
+            get(:matrix)
+          elsif setup
+            set(:matrix, { setup: setup })
+          else
+            set(:matrix, value)
+          end
+        end
+      end
+    end
+  end
+end 

data/lib/buildkite/pipelines/helpers.rb

@@ -9,6 +9,7 @@ module Buildkite
         depends_on: :DependsOn,
         key: :Key,
         label: :Label,
+        matrix: :Matrix,
         plugins: :Plugins,
         retry: :Retry,
         skip: :Skip,

data/lib/buildkite/pipelines/steps/command.rb

@@ -14,6 +14,7 @@ module Buildkite
         attribute :depends_on, append: true
         attribute :allow_dependency_failure
         attribute :parallelism
+        attribute :matrix
         attribute :branches
         attribute :artifact_paths
         attribute :agents

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 4.17.0
+  version: 4.19.0
 platform: ruby
 authors:
 - Ngan Pham
 - Andrew Lee
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-04 00:00:00.000000000 Z
+date: 2025-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -109,6 +110,7 @@ files:
 - VERSION
 - bin/buildkite-builder
 - bin/console
+- bin/release
 - bin/setup
 - exe/buildkite-builder
 - lib/buildkite-builder.rb
@@ -122,6 +124,7 @@ files:
 - lib/buildkite/builder/dsl.rb
 - lib/buildkite/builder/extension.rb
 - lib/buildkite/builder/extension_manager.rb
+- lib/buildkite/builder/extension_template.rb
 - lib/buildkite/builder/extensions.rb
 - lib/buildkite/builder/extensions/agents.rb
 - lib/buildkite/builder/extensions/env.rb
@@ -151,6 +154,7 @@ files:
 - lib/buildkite/pipelines/helpers/depends_on.rb
 - lib/buildkite/pipelines/helpers/key.rb
 - lib/buildkite/pipelines/helpers/label.rb
+- lib/buildkite/pipelines/helpers/matrix.rb
 - lib/buildkite/pipelines/helpers/plugins.rb
 - lib/buildkite/pipelines/helpers/retry.rb
 - lib/buildkite/pipelines/helpers/skip.rb
@@ -172,6 +176,7 @@ metadata:
   source_code_uri: https://github.com/Gusto/buildkite-builder
   changelog_uri: https://github.com/Gusto/buildkite-builder/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/Gusto/buildkite-builder/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,7 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.
 test_files: []