buildkite-builder 2.1.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1796ef4fc73c74c399a7eb271092baee5b0101e3c06598c8d837d1fd031876e2
-  data.tar.gz: c384d20a194cf13a8dff4e1057a1b07b777201fd717f1d75496d88ec04d7fbff
+  metadata.gz: b6e19458f7245c430927899fcb8a0a9d109abb85980dc9dd64ca679efec89617
+  data.tar.gz: 85593b91b77405e8e9fadbf4c485e86a4ce0c62747dacd3422c8e08e5c228666
 SHA512:
-  metadata.gz: cc19aa8d8c3af6f4fbbd0bd892d56f41243649b8b384e38f7391d8e198950704bc515530c022c231eb7d4368a7bed0f74fa0f4bab3c020813bf045b67a4d1062
-  data.tar.gz: e414869940fbb417e06192a7fdd48049d38564c00f1283a8110c2521462ce736ec890c7275c03c386b619ae718b654a4ac2cbbf460cb1f1dfd86cefb4e871b2c
+  metadata.gz: 878daff8f7270bc83de7dfd9d89938c7204bda1a014ed09e5e7c8d1378d1520abb94b102f052fb4312170b1c65a583f218c1b7e7c222b2ae5daed3a67728bcdb
+  data.tar.gz: 7365820be85d5d7b5c0123c86d5dd2c0015b15a7ee430c92b47750157f7bec1e3215a9161f212f7aa26e9da3c265352d2ec5fcb757fe761d714bab28d337cfa8

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 2.4.1
+* Fix pipeline upload as artifact logic.
+
+## 2.4.0
+* Upload custom pipeline artifacts in a single command.
+* Only upload the pipeline as an artifact when the pipeline upload fails.
+
+## 2.3.0
+* Improve BKB step idempotency.
+
+## 2.2.0
+* Add `.buildkite/lib` directory to $LOAD_PATH if it exists.
+
 ## 2.1.0
 * Fix a bug introduced in 2.0.0 where artifacts were being uploaded before extensions had a chance to do work.
 * Remove `SortedSet` dependency.

data/README.md

@@ -1,11 +1,12 @@
 # Buildkite Builder [![Build status](https://badge.buildkite.com/a26bf804e9a93fb118d29824d5695a601a248ceec51591be23.svg?branch=main)](https://buildkite.com/gusto-open-source/buildkite-builder/builds?branch=main)
 
 ## Introduction
+
 Buildkite Builder (BKB) is a Buildkite pipeline builder written in Ruby. It allows you to build your pipeline with a Ruby DSL for dynamically generated pipeline steps.
 
 ## Gem Installation (optional)
 
-There are 2 components to this toolkit. The `buildkite-builder` Rubygem and the `buildkite-builder` Docker image. You technically only need the image to use Buildkite Builder, but installing the gem in your repo helps you preview your pipeline during development.
+There are 2 components to this toolkit. The `buildkite-builder` RubyGem and the `buildkite-builder` Docker image. You technically only need the image to use Buildkite Builder, but installing the gem in your repo helps you preview your pipeline during development.
 
 To install the gem, add this line to your application's Gemfile:
 
@@ -16,7 +17,7 @@ gem 'buildkite-builder'
 The gem provides a command line tool that lets you perform various operations on your pipelines:
 
 ```shell
-  $ buildkite-builder help
+  buildkite-builder help
 ```
 
 ## Pipeline Installation
@@ -33,23 +34,26 @@ steps:
 ```
 
 Some things to note:
-  - The `label` can be whatever you like.
-  - You'll want to update the `docker` plugin version from time to time.
-  - You can update the `buildkite-builder` version by bumping the Docker image tag.
+
+- The `label` can be whatever you like.
+- You'll want to update the `docker` plugin version from time to time.
+- You can update the `buildkite-builder` version by bumping the Docker image tag.
 
 ## Usage
 
 💡 We have a [Showcase pipeline](https://buildkite.com/gusto-open-source/showcase/builds/latest?branch=main) (defined in [`.buildkite/pipelines/showcase/pipeline.rb`](https://github.com/Gusto/buildkite-builder/blob/main/.buildkite/pipelines/showcase/pipeline.rb)) that, well, showcases some of the features and possibilities with Buildkite Builder. Sometimes the best way to learning something is seeing how it's used.
 
 At its core, BKB is really just a YAML builder. This tool allows you to scale your needs when it comes to building a Buildkite pipeline. Your pipeline can be as straight forward as you'd like, or as complex as you need. Since you have Ruby at your disposal, you can do some cool things like:
-  - Perform pre-build code/diff analysis to determine whether or not to to add a step to the pipeline.
-  - Reorder pipeline steps dynamically.
-  - Augment your pipeline steps with BKB processors.
+
+- Perform pre-build code/diff analysis to determine whether or not to to add a step to the pipeline.
+- Reorder pipeline steps dynamically.
+- Augment your pipeline steps with BKB processors.
   
 ### Pipeline Files
+
 Your repo can contain as many pipeline definitions as you'd like. By convention, pipeline file structure are as such:
 
-```
+```console
 .buildkite/
   pipelines/
     <your-pipeline1-slug>/
@@ -95,7 +99,7 @@ If the step type or attribute exists in Buildkite docs, then it should exist in
 
 If your pipeline has a lot of steps, you should consider using Step Templates. Templates allow you to break out your build steps into reusable template files.
 
-```
+```console
 .buildkite/
   pipelines/
     foobar-widget/
@@ -108,6 +112,7 @@ If your pipeline has a lot of steps, you should consider using Step Templates. T
 A template is basically a step that was extracted from the pipeline:
 
 `.buildkite/pipelines/foobar-widget/templates/rspec.rb`
+
 ```ruby
 Buildkite::Builder.template do
   label "Rspec", emoji: :rspec
@@ -118,6 +123,7 @@ end
 You can then include the template into the the pipeline once or as many time as you need. The template name will be the name of the file (without the extension).
 
 `.buildkite/pipelines/foobar-widget/pipeline.rb`
+
 ```ruby
 Buildkite::Builder.pipeline do
   command(:rspec)
@@ -137,7 +143,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/gusto/buildkite-builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/gusto/buildkite-builder/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/gusto/buildkite-builder>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/gusto/buildkite-builder/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -145,4 +151,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Buildkite::Builder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gusto/buildkite-builder/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the `Buildkite::Builder` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gusto/buildkite-builder/blob/main/CODE_OF_CONDUCT.md).

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.4.1

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

@@ -15,8 +15,13 @@ module Buildkite
 
           # This entrypoint is for running on CI. It expects certain environment
           # variables to be set. It also uploads the pipeline to Buildkite.
-          log.info "#{'+++ ' if Buildkite.env}🧰 " + 'Buildkite Builder'.color(:springgreen) + " ─ #{relative_pipeline_path.to_s.yellow}"
-          Pipeline.new(pipeline_path, logger: log).upload
+          log.info "+++ 🧰 #{'Buildkite Builder'.color(:springgreen)} ─ #{relative_pipeline_path.to_s.yellow}"
+
+          if Buildkite::Pipelines::Command.meta_data(:exists, Builder::META_DATA.fetch(:job))
+            log.info 'Pipeline already uploaded'.color(:dimgray)
+          else
+            Pipeline.new(pipeline_path, logger: log).upload
+          end
         end
 
         private

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

@@ -0,0 +1,15 @@
+module Buildkite
+  module Builder
+    module Extensions
+      class Lib < Extension
+        def prepare
+          lib_dir = Buildkite::Builder.root.join(Buildkite::Builder::BUILDKITE_DIRECTORY_NAME, 'lib')
+
+          if lib_dir.directory? && !$LOAD_PATH.include?(lib_dir)
+            $LOAD_PATH.unshift(lib_dir)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/buildkite/builder/extensions.rb

@@ -4,6 +4,7 @@ module Buildkite
   module Builder
     module Extensions
       autoload :Env, File.expand_path('extensions/env', __dir__)
+      autoload :Lib, File.expand_path('extensions/lib', __dir__)
       autoload :Notify, File.expand_path('extensions/notify', __dir__)
       autoload :Steps, File.expand_path('extensions/steps', __dir__)
       autoload :Use, File.expand_path('extensions/use', __dir__)

data/lib/buildkite/builder/pipeline.rb

@@ -33,6 +33,7 @@ module Buildkite
         @data = Data.new
 
         use(Extensions::Use)
+        use(Extensions::Lib)
         use(Extensions::Env)
         use(Extensions::Notify)
         use(Extensions::Steps)
@@ -40,19 +41,25 @@ module Buildkite
       end
 
       def upload
+        # Generate the pipeline YAML first.
+        contents = to_yaml
+
+        upload_artifacts
+
         # Upload the pipeline.
         Tempfile.create(['pipeline', '.yml']) do |file|
           file.sync = true
-          file.write(to_yaml)
+          file.write(contents)
 
-          logger.info '+++ :paperclip: Uploading pipeline.yml as artifact'
-          Buildkite::Pipelines::Command.artifact!(:upload, file.path)
-          logger.info '+++ :pipeline: Uploading pipeline'
-          Buildkite::Pipelines::Command.pipeline!(:upload, file.path)
+          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
+          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.job_id)
         end
-
-        logger.info '+++ :paperclip: Uploading artifacts'
-        upload_artifacts
       end
 
       def to_h
@@ -84,11 +91,8 @@ module Buildkite
       def upload_artifacts
         return if artifacts.empty?
 
-        artifacts.each do |path|
-          if File.exist?(path)
-            Buildkite::Pipelines::Command.artifact!(:upload, path)
-          end
-        end
+        logger.info "+++ :paperclip: Uploading artifacts"
+        Buildkite::Pipelines::Command.artifact!(:upload, artifacts.join(";"))
       end
 
       def pipeline_definition

data/lib/buildkite/builder.rb

@@ -27,6 +27,9 @@ module Buildkite
     autoload :PluginManager, File.expand_path('builder/plugin_manager', __dir__)
 
     BUILDKITE_DIRECTORY_NAME = Pathname.new('.buildkite').freeze
+    META_DATA = {
+      job: 'buildkite-builder:job'
+    }.freeze
 
     class << self
       def root(start_path: Dir.pwd, reset: false)
@@ -46,7 +49,7 @@ module Buildkite
 
       def find_buildkite_directory(start_path)
         path = Pathname.new(start_path)
-        until path.join(BUILDKITE_DIRECTORY_NAME).exist? && path.join(BUILDKITE_DIRECTORY_NAME).directory?
+        until path.join(BUILDKITE_DIRECTORY_NAME).directory?
           raise "Unable to find #{BUILDKITE_DIRECTORY_NAME} from #{start_path}" if path == path.parent
 
           path = path.parent

data/lib/buildkite/pipelines/command.rb

@@ -4,29 +4,35 @@ module Buildkite
   module Pipelines
     class Command
       BIN_PATH = 'buildkite-agent'
+      COMMANDS = %w(
+        pipeline
+        artifact
+        annotate
+        meta_data
+      )
 
-      def self.pipeline!(*args)
-        abort unless pipeline(*args)
-      end
-
-      def self.pipeline(subcommand, *args)
-        new(:pipeline, subcommand, *args).run
-      end
+      class << self
+        def pipeline(subcommand, *args)
+          new(:pipeline, subcommand, *args).run
+        end
 
-      def self.artifact!(*args)
-        abort unless artifact(*args)
-      end
+        def artifact(subcommand, *args)
+          new(:artifact, subcommand, *args).run
+        end
 
-      def self.artifact(subcommand, *args)
-        new(:artifact, subcommand, *args).run
-      end
+        def annotate(body, *args)
+          new(:annotate, body, *args).run
+        end
 
-      def self.annotate(body, *args)
-        new(:annotate, body, *args).run
+        def meta_data(subcommand, *args)
+          new(:'meta-data', subcommand, *args).run
+        end
       end
 
-      def self.annotate!(*args)
-        abort unless annotate(*args)
+      COMMANDS.each do |command|
+        define_singleton_method("#{command}!") do |*args|
+          abort unless public_send(command, *args)
+        end
       end
 
       def initialize(command, subcommand, *args)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -126,6 +126,7 @@ files:
 - lib/buildkite/builder/extension_manager.rb
 - lib/buildkite/builder/extensions.rb
 - lib/buildkite/builder/extensions/env.rb
+- lib/buildkite/builder/extensions/lib.rb
 - lib/buildkite/builder/extensions/notify.rb
 - lib/buildkite/builder/extensions/steps.rb
 - lib/buildkite/builder/extensions/use.rb
@@ -195,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.2
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A gem for programmatically creating Buildkite pipelines.