Merge pull request #392 from wordpress-mobile/builkite_trigger/custom_message

Add the ability for the `buildkite_trigger_build` action to provide a custom message

Author: AliSoftware

CHANGELOG.md

@@ -11,6 +11,7 @@ _None_
 ### New Features
 
 - Add `tools:ignore="InconsistentArrays"` to `available_languages.xml` to avoid a linter warning on repos hosting multiple app flavors. [#390]
+- Add the ability to provide a custom message for builds triggered via `buildkite_trigger_build` action [#392]
 
 ### Bug Fixes
 * Fixes milestones being compared as strings instead of integers in `github_helper.get_last_milestone` [#391]

lib/fastlane/plugin/wpmreleasetoolkit/actions/common/buildkite_trigger_build_action.rb

@@ -9,16 +9,18 @@ def self.run(params)
         pipeline_name = {
           PIPELINE: params[:pipeline_file]
         }
+        options = {
+          branch: params[:branch],
+          commit: params[:commit],
+          env: params[:environment].merge(pipeline_name),
+          message: params[:message]
+        }.compact # remove entries with `nil` values from the Hash, if any
 
         client = Buildkit.new(token: params[:buildkite_token])
         response = client.create_build(
           params[:buildkite_organization],
           params[:buildkite_pipeline],
-          {
-            branch: params[:branch],
-            commit: params[:commit],
-            env: params[:environment].merge(pipeline_name)
-          }
+          options
         )
 
         response.state == 'scheduled' ? UI.message('Done!') : UI.crash!("Failed to start job\nError: [#{response}]")
@@ -64,6 +66,13 @@ def self.available_options
             type: String,
             default_value: 'HEAD'
           ),
+          FastlaneCore::ConfigItem.new(
+            key: :message,
+            description: 'A custom message to show for the build in Buildkite\'s UI',
+            type: String,
+            optional: true,
+            default_value: nil
+          ),
           FastlaneCore::ConfigItem.new(
             key: :pipeline_file,
             description: 'The name of the pipeline file in the project',