buildkite-builder 2.0.0.beta2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 671edc2f2b7a65af8d8c8d1390485c9591fb4814c1f9d1acb49e82fd3d648c27
-  data.tar.gz: 78f6374f0b352172d61185ed5bb9c9054dbf20581001d634d5474ffdaf13afdb
+  metadata.gz: 1796ef4fc73c74c399a7eb271092baee5b0101e3c06598c8d837d1fd031876e2
+  data.tar.gz: c384d20a194cf13a8dff4e1057a1b07b777201fd717f1d75496d88ec04d7fbff
 SHA512:
-  metadata.gz: 8be88ac275466dc0dec40db8ce78f752b488b568ed7b32403977e53905fc4fd8518298716cb1864a5bb9ab6a51ea3ed3572051a839f215c76cf7b6e6efdbf218
-  data.tar.gz: 013a0a8e0ea3a56671088a1ec32994d456e83f49fd64b1b8d802b4fce53f54048581d10f21db56d213a8f9057797f494627b14e7390df83bc0b19ee6aceefb19
+  metadata.gz: cc19aa8d8c3af6f4fbbd0bd892d56f41243649b8b384e38f7391d8e198950704bc515530c022c231eb7d4368a7bed0f74fa0f4bab3c020813bf045b67a4d1062
+  data.tar.gz: e414869940fbb417e06192a7fdd48049d38564c00f1283a8110c2521462ce736ec890c7275c03c386b619ae718b654a4ac2cbbf460cb1f1dfd86cefb4e871b2c

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 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.
+* Add `annotate` pipeline command helper.
+* Add `StepCollection#find` and `StepCollection#find!` for ease of finding a step by its key in extensions.
+* `group` now supports the `emoji:` helper. (Eg. `group "foobar", emoji: :smile`)
+
+## 2.0.0
+* Add support for `group`.
+* `Processor`s has been renamed to `Extension`. Extensions add more capabilities (will document separately).
+* `plugin` no longer takes 2 arguments (source, version). It's simply 1 arg that is both source and version, separated by a `#`. This is more akin to Buildkite's usage.
+* Full refactor of pipeline code allowing for extensions to extend DSL methods.
+
 ## 1.5.0
 * Merge `BuildKite::Builder::Context` and `BuildKite::Pipelines::Pipeline` to `BuildKite::Builder::Pipeline` (#37)
 

data/README.md

@@ -28,7 +28,7 @@ steps:
   - label: ":toolbox:"
     plugins:
       - docker#v3.7.0:
-          image: gusto/buildkite-builder:1.2.0
+          image: gusto/buildkite-builder:2.1.0
           propagate-environment: true
 ```
 

data/VERSION

@@ -1 +1 @@
-2.0.0.beta2
+2.1.0

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

@@ -4,20 +4,25 @@ module Buildkite
       class Steps < Extension
         def prepare
           context.data.steps = StepCollection.new(
-            TemplateRegistry.new(context.root),
-            PluginRegistry.new
+            TemplateManager.new(context.root),
+            PluginManager.new
           )
         end
 
         dsl do
-          def group(label = nil, &block)
+          def group(label = nil, emoji: nil, &block)
             raise "Group does not allow nested in another Group" if context.is_a?(Group)
 
+            if emoji
+              emoji = Array(emoji).map { |name| ":#{name}:" }.join
+              label = [emoji, label].compact.join(' ')
+            end
+
             context.data.steps.push(Buildkite::Builder::Group.new(label, context.data.steps, &block))
           end
 
-          def plugin(name, uri, version)
-            context.data.steps.plugins.add(name, uri, version)
+          def plugin(name, uri)
+            context.data.steps.plugins.add(name, uri)
           end
 
           def block(template = nil, **args, &block)

data/lib/buildkite/builder/file_resolver.rb

@@ -20,7 +20,7 @@ module Buildkite
       end
 
       def initialize
-        @modified_files = SortedSet.new(pull_request? ? files_from_pull_request : files_from_git)
+        @modified_files = Set.new(pull_request? ? files_from_pull_request.sort! : files_from_git.sort!)
       end
 
       private

data/lib/buildkite/builder/manifest/rule.rb

@@ -36,7 +36,7 @@ module Buildkite
           matched.map! { |file| Pathname.new(file) }
           matched.reject!(&:directory?)
           matched.map! { |file| file.relative_path_from(Builder.root) }
-          SortedSet.new(matched)
+          Set.new(matched.sort!)
         end
       end
 

data/lib/buildkite/builder/manifest.rb

@@ -2,7 +2,6 @@
 
 require 'digest/md5'
 require 'pathname'
-require 'sorted_set'
 
 module Buildkite
   module Builder
@@ -56,7 +55,7 @@ module Buildkite
       end
 
       def files
-        @files ||= inclusion_rules.map(&:files).reduce(SortedSet.new, :merge) - exclusion_rules.map(&:files).reduce(SortedSet.new, :merge)
+        @files ||= (inclusion_rules.map(&:files).reduce(Set.new, :merge) - exclusion_rules.map(&:files).reduce(Set.new, :merge)).sort.to_set
       end
 
       def digest

data/lib/buildkite/builder/pipeline.rb

@@ -40,9 +40,6 @@ module Buildkite
       end
 
       def upload
-        logger.info '+++ :paperclip: Uploading artifacts'
-        upload_artifacts
-
         # Upload the pipeline.
         Tempfile.create(['pipeline', '.yml']) do |file|
           file.sync = true
@@ -53,6 +50,9 @@ module Buildkite
           logger.info '+++ :pipeline: Uploading pipeline'
           Buildkite::Pipelines::Command.pipeline!(:upload, file.path)
         end
+
+        logger.info '+++ :paperclip: Uploading artifacts'
+        upload_artifacts
       end
 
       def to_h

data/lib/buildkite/builder/plugin.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Buildkite
+  module Builder
+    class Plugin
+      attr_reader :uri, :source, :version, :options
+
+      def initialize(uri, options = nil)
+        @uri = uri
+        @source, @version = uri.split('#')
+        @options = options
+      end
+
+      def to_h
+        Buildkite::Pipelines::Helpers.sanitize(uri => options)
+      end
+    end
+  end
+end

data/lib/buildkite/builder/plugin_collection.rb

@@ -0,0 +1,49 @@
+module Buildkite
+  module Builder
+    class PluginCollection
+      attr_reader :plugin_manager
+
+      def initialize(plugin_manager)
+        @plugin_manager = plugin_manager
+        @collection = []
+      end
+
+      def add(resource, options = nil)
+        plugin =
+          case resource
+          when Symbol
+            uri = plugin_manager.fetch(resource.to_s)
+
+            raise ArgumentError, "Plugin `#{resource}` does not exist" unless uri
+
+            Plugin.new(uri, options)
+          when String
+            Plugin.new(resource, options)
+          when Plugin
+            resource
+          else
+            raise ArgumentError, "Unknown plugin `#{resource.inspect}`"
+          end
+
+        @collection.push(plugin).last
+      end
+
+      def find(source)
+        source_string =
+          case source
+          when String then source
+          when Plugin then source.source
+          else raise ArgumentError, "Unknown source #{source.inspect}"
+          end
+
+        @collection.select do |plugin|
+          plugin.source == source_string
+        end
+      end
+
+      def to_definition
+        @collection.map(&:to_h)
+      end
+    end
+  end
+end

data/lib/buildkite/builder/{plugin_registry.rb → plugin_manager.rb}

@@ -1,18 +1,18 @@
 module Buildkite
   module Builder
-    class PluginRegistry
+    class PluginManager
       def initialize
         @plugins = {}
       end
 
-      def add(name, uri, version)
+      def add(name, uri)
         name = name.to_s
 
         if @plugins.key?(name)
           raise ArgumentError, "Plugin already defined: #{name}"
         end
 
-        @plugins[name] = [uri, version]
+        @plugins[name] = uri
       end
 
       def fetch(name)

data/lib/buildkite/builder/step_collection.rb

@@ -27,6 +27,14 @@ module Buildkite
         end
       end
 
+      def find(key)
+        @steps.find { |step| step.has?(:key) && step.key == key.to_s }
+      end
+
+      def find!(key)
+        find(key) || raise(ArgumentError, "Can't find step with key: #{key}")
+      end
+
       def add(step_class, template = nil, **args, &block)
         @steps.push(step_class.new(self, template, **args, &block)).last
       end

data/lib/buildkite/builder/{template_registry.rb → template_manager.rb}

@@ -1,6 +1,6 @@
 module Buildkite
   module Builder
-    class TemplateRegistry
+    class TemplateManager
       def initialize(root)
         @templates = {}
 

data/lib/buildkite/builder.rb

@@ -20,9 +20,11 @@ module Buildkite
     autoload :Manifest, File.expand_path('builder/manifest', __dir__)
     autoload :Processors, File.expand_path('builder/processors', __dir__)
     autoload :Rainbow, File.expand_path('builder/rainbow', __dir__)
+    autoload :Plugin, File.expand_path('builder/plugin', __dir__)
+    autoload :PluginCollection, File.expand_path('builder/plugin_collection', __dir__)
     autoload :StepCollection, File.expand_path('builder/step_collection', __dir__)
-    autoload :TemplateRegistry, File.expand_path('builder/template_registry', __dir__)
-    autoload :PluginRegistry, File.expand_path('builder/plugin_registry', __dir__)
+    autoload :TemplateManager, File.expand_path('builder/template_manager', __dir__)
+    autoload :PluginManager, File.expand_path('builder/plugin_manager', __dir__)
 
     BUILDKITE_DIRECTORY_NAME = Pathname.new('.buildkite').freeze
 

data/lib/buildkite/pipelines/attributes.rb

@@ -48,7 +48,9 @@ module Buildkite
 
       def to_h
         permitted_attributes.each_with_object({}) do |attr, hash|
-          hash[attr] = get(attr) if has?(attr)
+          next unless has?(attr)
+
+          hash[attr] = get(attr).respond_to?(:to_definition) ? get(attr).to_definition : get(attr)
         end
       end
 

data/lib/buildkite/pipelines/command.rb

@@ -21,6 +21,14 @@ module Buildkite
         new(:artifact, subcommand, *args).run
       end
 
+      def self.annotate(body, *args)
+        new(:annotate, body, *args).run
+      end
+
+      def self.annotate!(*args)
+        abort unless annotate(*args)
+      end
+
       def initialize(command, subcommand, *args)
         @command = command.to_s
         @subcommand = subcommand.to_s

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

@@ -4,19 +4,13 @@ module Buildkite
   module Pipelines
     module Helpers
       module Plugins
-        def plugin(plugin_name, options = nil)
-          plugin_name = plugin_name.to_s
-          @plugins ||= {}
-
-          if @plugins.key?(plugin_name)
-            raise ArgumentError, "Plugin already used for command step: #{plugin_name}"
-          end
-
-          uri, version = step_collection.plugins.fetch(plugin_name)
-          new_plugin = Plugin.new(uri, version, options)
-          @plugins[plugin_name] = new_plugin
+        def plugin(name_or_source, options = nil)
+          attributes['plugins'] ||= Buildkite::Builder::PluginCollection.new(step_collection.plugins)
+          attributes['plugins'].add(name_or_source, options)
+        end
 
-          plugins(new_plugin.to_h)
+        def plugins
+          attributes['plugins']
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buildkite-builder
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.1.0
 platform: ruby
 authors:
 - Ngan Pham
@@ -9,22 +9,8 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: sorted_set
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -155,10 +141,12 @@ files:
 - lib/buildkite/builder/manifest.rb
 - lib/buildkite/builder/manifest/rule.rb
 - lib/buildkite/builder/pipeline.rb
-- lib/buildkite/builder/plugin_registry.rb
+- lib/buildkite/builder/plugin.rb
+- lib/buildkite/builder/plugin_collection.rb
+- lib/buildkite/builder/plugin_manager.rb
 - lib/buildkite/builder/rainbow.rb
 - lib/buildkite/builder/step_collection.rb
-- lib/buildkite/builder/template_registry.rb
+- lib/buildkite/builder/template_manager.rb
 - lib/buildkite/env.rb
 - lib/buildkite/pipelines.rb
 - lib/buildkite/pipelines/api.rb
@@ -175,7 +163,6 @@ files:
 - lib/buildkite/pipelines/helpers/skip.rb
 - lib/buildkite/pipelines/helpers/soft_fail.rb
 - lib/buildkite/pipelines/helpers/timeout_in_minutes.rb
-- lib/buildkite/pipelines/plugin.rb
 - lib/buildkite/pipelines/step_context.rb
 - lib/buildkite/pipelines/steps.rb
 - lib/buildkite/pipelines/steps/abstract.rb
@@ -204,9 +191,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.2
 signing_key:

data/lib/buildkite/pipelines/plugin.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Buildkite
-  module Pipelines
-    class Plugin
-      attr_reader :uri, :version, :options
-
-      def initialize(uri, version, options = nil)
-        @uri = uri
-        @version = version
-        @options = options
-      end
-
-      def full_uri
-        "#{uri}##{version}"
-      end
-
-      def to_h
-        Helpers.sanitize(full_uri => options)
-      end
-    end
-  end
-end