buildkite-builder 4.4.0 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f89af006c84e916bc75c42fec68f5e308544592b49dcee1b8e0cdde4029bf6
-  data.tar.gz: ce1c87417d57468896e8f15be3e3678de6c920625b3b070c3b84c3c553ae0c59
+  metadata.gz: 4bf8325879836987ca1d33d9822e1c2aaf315843c7ee2b99e5791378a893c767
+  data.tar.gz: 2e9edbde3a0db277878a8f307ef0e1975a4dde99c396e87a3ecb1b9b2673b405
 SHA512:
-  metadata.gz: bb99d435663020e86296e11f330f5d0f58832486a89febac1b4e199ae48a2a463e2be4906b226f9d654a46b49fc091c33d0481e56f7949c28004db7e17917958
-  data.tar.gz: 2943c7b52a2e1ef61f9325758255fdd29fe037b3ac658db2ffd298a2ff2ecc2aa544c5aba7b16a2135e7abb7814166feb5608c064e98b2a4077a825f062dd54c
+  metadata.gz: bb4cf5652a702e0d030350db16c0447d72cd2000a6cb32fa4f1a89d00c38cc0e5820661ca1fb67de8abe4a56b177172a4a806a4d05ff954744a01dcd2ec56c32
+  data.tar.gz: c04110b0ca0f550a4a2be480f9aecde71566358fb9d638a4a0c96d1c503c3de6272a75b78083bb21b60d81a3fc12d4440c80445e5a0f9d41bbae5ea4a130ee30

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 4.6.0
+* Remove `capture` concept on `Buildkite::Pipelines::Command#run` and replaced with `Buildkite::Pipelines::Command::Result` object to represent `Open3.capture3` result.
+
+### 4.5.0
+* Do not upload `pipeline.yml` when steps is empty.
+
 ### 4.4.0
 * Fix multiple arguments for `depends_on`.
 

data/VERSION

@@ -1 +1 @@
-4.4.0
+4.6.0

data/lib/buildkite/builder/commands/run.rb

@@ -17,7 +17,7 @@ module Buildkite
           # variables to be set. It also uploads the pipeline to Buildkite.
           log.info "+++ 🧰 #{'Buildkite Builder'.color(:springgreen)} v#{Buildkite::Builder.version} ─ #{relative_pipeline_path.to_s.yellow}"
 
-          if Buildkite::Pipelines::Command.meta_data(:exists, Builder.meta_data.fetch(:job))
+          if Buildkite::Pipelines::Command.meta_data(:exists, Builder.meta_data.fetch(:job)).success?
             log.info "Pipeline already uploaded in #{Buildkite.env.step_id} step".color(:dimgray)
           else
             Pipeline.new(pipeline_path, logger: log).upload

data/lib/buildkite/builder/pipeline.rb

@@ -45,20 +45,28 @@ module Buildkite
 
         upload_artifacts
 
-        # Upload the pipeline.
-        Tempfile.create(['pipeline', '.yml']) do |file|
-          file.sync = true
-          file.write(contents)
-
-          logger.info "+++ :pipeline: Uploading pipeline"
-          unless Buildkite::Pipelines::Command.pipeline(:upload, file.path)
-            logger.info "Pipeline upload failed, saving as artifact…"
-            Buildkite::Pipelines::Command.artifact!(:upload, file.path)
-            abort
+        if data.steps.empty?
+          logger.info "+++ :pipeline: No steps defined, skipping pipeline upload"
+        else
+          # Upload the pipeline.
+          Tempfile.create(['pipeline', '.yml']) do |file|
+            file.sync = true
+            file.write(contents)
+
+            logger.info "+++ :pipeline: Uploading pipeline"
+
+            result = Buildkite::Pipelines::Command.pipeline(:upload, file.path)
+
+            unless result.success?
+              logger.info "Pipeline upload failed with #{result.stderr}, saving as artifact…"
+              Buildkite::Pipelines::Command.artifact!(:upload, file.path)
+              abort
+            end
           end
-          logger.info "+++ :toolbox: Setting job meta-data to #{Buildkite.env.job_id.color(:yellow)}"
-          Buildkite::Pipelines::Command.meta_data!(:set, Builder.meta_data.fetch(:job), Buildkite.env.step_id)
         end
+
+        logger.info "+++ :toolbox: Setting job meta-data to #{Buildkite.env.job_id.color(:yellow)}"
+        Buildkite::Pipelines::Command.meta_data!(:set, Builder.meta_data.fetch(:job), Buildkite.env.step_id)
       end
 
       def to_h

data/lib/buildkite/builder/step_collection.rb

@@ -55,6 +55,10 @@ module Buildkite
       def to_definition
         @steps.map(&:to_h)
       end
+
+      def empty?
+        @steps.empty? || (@steps.all? { |step| step.is_a?(Pipelines::Steps::Group) && step.steps.empty? })
+      end
     end
   end
 end

data/lib/buildkite/pipelines/command.rb

@@ -7,6 +7,23 @@ module Buildkite
     class Command
       class CommandFailedError < StandardError; end
 
+      class Result
+        attr_reader :stdout, :stderr
+        def initialize(stdout, stderr, status)
+          @stdout = stdout.strip
+          @stderr = stderr.strip
+          @status = status
+        end
+
+        def success?
+          @status.success?
+        end
+
+        def output
+          @output ||= "#{stdout}\n#{stderr}".strip
+        end
+      end
+
       BIN_PATH = 'buildkite-agent'
       COMMANDS = %w(
         pipeline
@@ -21,12 +38,12 @@ module Buildkite
         end
 
         def artifact(subcommand, *args, exception: false)
-          capture = case subcommand.to_s
-          when 'shasum', 'search' then true
-          else false
-          end
+          result = new(:artifact, subcommand, *args).run(exception: exception)
 
-          new(:artifact, subcommand, *args).run(capture: capture, exception: exception)
+          case subcommand.to_s
+          when 'shasum', 'search' then result.output
+          else result
+          end
         end
 
         def annotate(body, *args, exception: false)
@@ -34,12 +51,12 @@ module Buildkite
         end
 
         def meta_data(subcommand, *args, exception: false)
-          capture = case subcommand.to_s
-          when 'get', 'keys' then true
-          else false
-          end
+          result = new(:'meta-data', subcommand, *args).run(exception: exception)
 
-          new(:'meta-data', subcommand, *args).run(capture: capture, exception: exception)
+          case subcommand.to_s
+          when 'get', 'keys' then result.output
+          else result
+          end
         end
       end
 
@@ -58,16 +75,14 @@ module Buildkite
         @args = transform_args(args)
       end
 
-      def run(capture: false, exception: false)
+      def run(exception: false)
         stdout, stderr, status = Open3.capture3(*to_a)
-        if capture
-          stdout
-        elsif status.success?
-          true
-        elsif exception
-          raise CommandFailedError, "#{stdout}\n#{stderr}"
+        result = Result.new(stdout, stderr, status)
+
+        if !result.success? && exception
+          raise CommandFailedError, "#{result.output}"
         else
-          false
+          result
         end
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.6.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-12-12 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.3.13
 signing_key:
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.