buildkite-builder 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bef719c816c5d64756bbcd041ca2a3fabe8fe59bff47cc154948207ce64a672f
-  data.tar.gz: f25762b1422e540f395526df9d6082e1d5908ea0b9b290bf025a365b56c317ff
+  metadata.gz: d50f76bdcfda9a7561fce2b86dbae5b0ea99d37c0dbd6c763b35541a39e904c8
+  data.tar.gz: 2fbd91625db37b0bf88546931254b4f4024de25d3d20d09267318eafae2e3646
 SHA512:
-  metadata.gz: c00f3fba91b34cf907c99ff839612270ef8aecb754c988af52226e979d5e743a508963d1d06d9957b529a2e3ba47cf6ba0951ec33290b8581dc9937b4178033a
-  data.tar.gz: 6e62bff8ecdb50b72bdb3afb8fd6fa1385f17ef1852b607f5273570cab1d396ee65d8908a78604d48ccb7a564ad4cb0f9dbff6b94b7a016cfd9ee881e1d4098a
+  metadata.gz: 5902b46da66c6ec7828d1bdf4f148f5445f2c7820e9f209e4a7ea22dae1ac8e62ea397660cca1f512737681c4c9397b97d5361f0fd64dba95066cb32751489ad
+  data.tar.gz: f67169e9bbdb7b84ccc1a6a8fec9593e878b70759e74f7236f595a3772649ce140d3ae99a329e090fb514c9bbbb450d70e58ea6362459404bced23f4a575cab1

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.2.0
+* Remove `template` from sub-pipeline trigger step setup and use arguments instead.
+
 ## 3.1.0
 * Add subpipeline support to save triggered pipeline's YML definition beforehand to artifacts and pass down the file to an ENV for pipeline setup.
 

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.2.0

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

@@ -7,7 +7,7 @@ module Buildkite
         class Pipeline
           include Buildkite::Pipelines::Attributes
 
-          attr_reader :data, :name
+          attr_reader :data, :name, :dsl
 
           attribute :depends_on, append: true
           attribute :key
@@ -16,26 +16,33 @@ module Buildkite
             name.split('::').last.downcase.to_sym
           end
 
-          def initialize(name, steps, &block)
+          def initialize(name, context, &block)
+            @context = context
             @name = name
             @data = Data.new
             @data.steps = StepCollection.new(
-              steps.templates,
-              steps.plugins
+              context.data.steps.templates,
+              context.data.steps.plugins
             )
             @data.notify = []
             @data.env = {}
 
-            @dsl = Dsl.new(self)
-            @dsl.extend(Extensions::Steps)
-            @dsl.extend(Extensions::Notify)
-            @dsl.extend(Extensions::Env)
+            # Use `clone` to copy over dsl's extended extensions
+            @dsl = context.dsl.clone
+            # Override dsl context to current pipeline
+            @dsl.instance_variable_set(:@context, self)
+
             instance_eval(&block) if block_given?
             self
           end
 
           def to_h
             attributes = super
+            # Merge envs from main pipeline, since ruby does not have `reverse_merge` and
+            # `data` does not allow keys override, we have to reset the data hash per key.
+            @context.data.env.merge(data.env).each do |key, value|
+              data.env[key] = value
+            end
             attributes.merge(data.to_definition)
           end
 
@@ -53,40 +60,43 @@ module Buildkite
         end
 
         dsl do
-          def pipeline(name, template = nil, &block)
+          def pipeline(name, **options, &block)
             raise "Subpipeline must have a name" if name.empty?
             raise "Subpipeline does not allow nested in another Subpipeline" if context.is_a?(Buildkite::Builder::Extensions::SubPipelines::Pipeline)
-            sub_pipeline = Buildkite::Builder::Extensions::SubPipelines::Pipeline.new(name, context.data.steps, &block)
 
+            sub_pipeline = Buildkite::Builder::Extensions::SubPipelines::Pipeline.new(name, context, &block)
             context.data.pipelines.add(sub_pipeline)
 
-            if template
-              # Use predefined template
-              step = context.data.steps.add(Pipelines::Steps::Trigger, template)
-
-              if step.build.nil?
-                step.build(env: { BKB_SUBPIPELINE_FILE: sub_pipeline.pipeline_yml })
-              else
-                step.build[:env].merge!(BKB_SUBPIPELINE_FILE: sub_pipeline.pipeline_yml)
-              end
-            else
-              # Generic trigger step
-              context.data.steps.add(Pipelines::Steps::Trigger, key: "subpipeline_#{name}_#{context.data.pipelines.count}") do |context|
-                key context[:key]
-                label name.capitalize
-                trigger name
-                build(
-                  message: '${BUILDKITE_MESSAGE}',
-                  commit: '${BUILDKITE_COMMIT}',
-                  branch: '${BUILDKITE_BRANCH}',
-                  env: {
-                    BUILDKITE_PULL_REQUEST: '${BUILDKITE_PULL_REQUEST}',
-                    BUILDKITE_PULL_REQUEST_BASE_BRANCH: '${BUILDKITE_PULL_REQUEST_BASE_BRANCH}',
-                    BUILDKITE_PULL_REQUEST_REPO: '${BUILDKITE_PULL_REQUEST_REPO}',
-                    BKB_SUBPIPELINE_FILE: sub_pipeline.pipeline_yml
-                  }
-                )
-              end
+            options = options.slice(:key, :label, :async, :branches, :condition, :depends_on, :allow_dependency_failure, :skip, :emoji)
+            options[:key] ||= "subpipeline_#{name}_#{context.data.pipelines.count}"
+            options[:label] ||= name.capitalize
+
+            if options[:emoji]
+              emoji = Array(options.delete(:emoji)).map { |name| ":#{name}:" }.join
+              options[:label] = [emoji, options[:label]].compact.join(' ')
+            end
+
+            context.data.steps.add(Pipelines::Steps::Trigger, **options) do |context|
+              key context[:key]
+              label context[:label]
+              trigger name
+              build(
+                message: '${BUILDKITE_MESSAGE}',
+                commit: '${BUILDKITE_COMMIT}',
+                branch: '${BUILDKITE_BRANCH}',
+                env: {
+                  BUILDKITE_PULL_REQUEST: '${BUILDKITE_PULL_REQUEST}',
+                  BUILDKITE_PULL_REQUEST_BASE_BRANCH: '${BUILDKITE_PULL_REQUEST_BASE_BRANCH}',
+                  BUILDKITE_PULL_REQUEST_REPO: '${BUILDKITE_PULL_REQUEST_REPO}',
+                  BKB_SUBPIPELINE_FILE: sub_pipeline.pipeline_yml
+                }
+              )
+              async context[:async] || false
+              branches context[:branches] if context[:branches]
+              condition context[:condition] if context[:condition]
+              depends_on *context[:depends_on] if context[:depends_on]
+              allow_dependency_failure context[:allow_dependency_failure] || false
+              skip context[:skip] || false
             end
           end
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow