buildkite-builder 3.1.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bef719c816c5d64756bbcd041ca2a3fabe8fe59bff47cc154948207ce64a672f
-  data.tar.gz: f25762b1422e540f395526df9d6082e1d5908ea0b9b290bf025a365b56c317ff
+  metadata.gz: ad16f8a66cf5c9c52bbbce15ccbd29589294309739a63f67a8982403f51b9b36
+  data.tar.gz: d148df13c7489629bb2d23c772fa309f937cf65ceafd46eb0303d199b4292f0b
 SHA512:
-  metadata.gz: c00f3fba91b34cf907c99ff839612270ef8aecb754c988af52226e979d5e743a508963d1d06d9957b529a2e3ba47cf6ba0951ec33290b8581dc9937b4178033a
-  data.tar.gz: 6e62bff8ecdb50b72bdb3afb8fd6fa1385f17ef1852b607f5273570cab1d396ee65d8908a78604d48ccb7a564ad4cb0f9dbff6b94b7a016cfd9ee881e1d4098a
+  metadata.gz: 7be78bd7cf1891adaf95c557861c6f5b8cc8b16e28ecabae1406eba44526e0e16fc13df245d253f73892dae0324255d2ecb6837643ef1058b18bfdb87801521b
+  data.tar.gz: 2ae512dbf1f76794531d5f4ef278fffc061e10d21074d8eb0de7454cc55b2dc50b61c5b30695152283790234a3a9da52ccd4b734067ed7bdc90b7898304feec9

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 3.3.1
+* Add support to iterate over subpipelines.
+* Allow build options to be passed to subpipelines.
+
+## 3.3.0
+* Remove arguments in sub-pipeline's trigger step setup and use dsl delegation instead.
+
+## 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.3.1

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

@@ -7,35 +7,50 @@ module Buildkite
         class Pipeline
           include Buildkite::Pipelines::Attributes
 
-          attr_reader :data, :name
+          attr_reader :data, :name, :dsl
 
-          attribute :depends_on, append: true
+          # These attributes are for triggered step
+          attribute :label
           attribute :key
+          attribute :skip
+          attribute :if, as: :condition
+          attribute :depends_on, append: true
+          attribute :allow_dependency_failure
+          attribute :branches
+          attribute :async
+          attribute :build
 
           def self.to_sym
             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,41 +68,38 @@ module Buildkite
         end
 
         dsl do
-          def pipeline(name, template = nil, &block)
+          def pipeline(name, &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
-            end
+            trigger_step = context.data.steps.add(Pipelines::Steps::Trigger)
+            trigger_step.trigger(name)
+
+            build_options = {
+              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
+              }
+            }
+            build_options.merge!(sub_pipeline.build) if sub_pipeline.build
+
+            trigger_step.build(build_options)
+            trigger_step.key(sub_pipeline.key || "subpipeline_#{name}_#{context.data.pipelines.count}")
+            trigger_step.label(sub_pipeline.label || name.capitalize)
+            trigger_step.async(sub_pipeline.async || false)
+            trigger_step.branches(sub_pipeline.branches) if sub_pipeline.branches
+            trigger_step.condition(sub_pipeline.condition) if sub_pipeline.condition
+            trigger_step.depends_on(*sub_pipeline.get('depends_on')) if sub_pipeline.get('depends_on')
+            trigger_step.allow_dependency_failure(sub_pipeline.allow_dependency_failure || false)
+            trigger_step.skip(sub_pipeline.skip || false)
           end
         end
       end

data/lib/buildkite/builder/pipeline_collection.rb

@@ -8,6 +8,7 @@ module Buildkite
       attr_reader :pipelines
 
       def_delegator :@pipelines, :count
+      def_delegator :@pipelines, :each
 
       def initialize(artifacts)
         @artifacts = artifacts

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Ngan Pham
 - Andrew Lee
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -177,7 +177,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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -192,8 +192,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.
 test_files: []