concourse 0.31.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f859958c7114b55262482115c7be4c753b377456c908c9a9e5f2d6838cb0acdc
-  data.tar.gz: 248381a82df8a6aba7143c4c39d07ad94da9cec2ea7168ccee3c02468d915c02
+  metadata.gz: 5ee9d14472f71531d1303d73d5d2804ae33f52cf392a7bf5d0eb4e99272f7519
+  data.tar.gz: 3863c480c23fe1d1581eecef2e80aa21d94fce9e076f7e3ddcc9a91108eb1363
 SHA512:
-  metadata.gz: 27db20bc6c2519868063e238bc6dbb64eb2844f4987cb67d31d818014275ea16e9f6d4a1ecd4edce2e2acb4ce16f19a061ec699436d1ef4faf56dab74828ffe3
-  data.tar.gz: 5a93ad3d9290ac1d27cbe979554cc401e2994f85d03a5245e57816a426d17d07b91e74d93c0a0931c68067ada568393fab71337b69ab38dae82d11991caaf754
+  metadata.gz: 2f0e5f4b885c01031e20c8bcfe370581a576be9a637d5cae3d2eb08766d64fab8dbde4869087b26ab9723615b8ddff452f4cb7baab6ec33e9c1babefd8df5fb1
+  data.tar.gz: 9796002bff87ce378dd34af27a4b120f18b4583694d0e977a3390a6acaaed46ccb5897f3848c0a1c7537762a46c33ac3d42f96e2effee73be1fd3e71bb74dece

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # concourse-gem changelog
 
+## v0.36.0 / 2020-09-07
+
+* remove generated pipelines from rake's "CLOBBER" global (generated pipelines have been recommended for checkin to source control since v0.26.0)
+
+
+## v0.35.0 / 2020-09-07
+
+* remove "clean" rake task (generated pipelines have been recommended for checkin to source control since v0.26.0)
+
+
+## v0.34.0 / 2020-08-31
+
+* allow injection of fly command arguments via `fly_args_<command_name>`
+
+
+## v0.33.0 / 2020-03-31
+
+* add `format` option for formatting final pipeline files with `fly format-pipeline`
+
+
+## v0.32.0 / 2020-03-29
+
+* avoid deprecation warning for `Bundler.with_clean_env`
+
+
+## v0.31.0 / 2020-01-11
+
+* remove jruby 9.1 (which corresponds to ruby 2.3)
+
+
+## v0.30.0 / 2020-01-11
+
+* remove ruby 2.3, which has reached EOL
+* change ruby 2.7-rc to 2.7 (final)
+
+
 ## v0.29.0 / 2019-10-28
 
 * add `2.7-rc` to the set of MRI Rubies

data/README.md

@@ -28,8 +28,10 @@ Here's an example pipeline maintained by this gem:
 - [Configuration](#configuration)
   * [`directory`: Concourse subdirectory name](#directory-concourse-subdirectory-name)
   * [`fly_target`: Concourse `fly` target name](#fly_target-concourse-fly-target-name)
+  * [`format`: Emit the final pipelines in `fly format-pipeline` canonical format](#format-emit-the-final-pipelines-in-fly-format-pipeline-canonical-format)
   * [`pipeline_erb_filename`: Pipeline filename](#pipeline_erb_filename-pipeline-filename)
   * [`secrets_filename`: Secrets filename](#secrets_filename-secrets-filename)
+  * [`fly_args_`: fly command arguments](#fly_args_-fly-command-arguments)
 - [Rake Tasks](#rake-tasks)
   * [Manage your Concourse pipeline](#manage-your-concourse-pipeline)
   * [List pipeline tasks](#list-pipeline-tasks)
@@ -225,6 +227,17 @@ Concourse.new("myproject", fly_target: "myci").create_tasks! # `fly -t myci <com
 ```
 
 
+### `format`: Emit the final pipelines in `fly format-pipeline` canonical format
+
+If you'd prefer to have your final pipeline files in `fly`'s "canonical format" (via `format-pipeline`), then set this to true!
+
+``` ruby
+Concourse.new("myproject", format: true).create_tasks!
+```
+
+This might be useful if you're heavily refactoring your template, and want to make sure there aren't unexpected changes to the pipeline.
+
+
 ### `pipeline_erb_filename`: Pipeline filename
 
 By default the pipeline file will be named `<myproject>.yml`, but can be set to something else:
@@ -246,6 +259,19 @@ Concourse.new("myproject", secrets_filename: "secrets.yml").create_tasks!
 ```
 
 
+### `fly_args_<fly_command>`: fly command arguments
+
+Rarely, you may need to inject additional commandline arguments into `fly` to get the behavior you want. For example, I wanted to inject `--enable-across-step` into my `validate-pipeline` commands when I started exploring matrix builds via [the `across` step](https://github.com/vito/rfcs/blob/spatial-resources/029-across-step/proposal.md).
+
+You can pass in additional keys named `fly_args_<command-name-with-underscores>` like this:
+
+``` ruby
+Concourse.new("myproject", fly_args_validate_pipeline: "--enable-across-step --another-flag")
+```
+
+With the above initializer call, whenever the `concourse` gem invokes `validate-pipeline`, it will inject `--enable-across-step --another-flag`.
+
+
 ## Rake Tasks
 
 

data/lib/concourse.rb

@@ -25,7 +25,9 @@ class Concourse
   attr_reader :directory
   attr_reader :pipelines
   attr_reader :fly_target
+  attr_reader :fly_args
   attr_reader :secrets_filename
+  attr_reader :format
 
   CONCOURSE_DOCKER_COMPOSE = "docker-compose.yml"
 
@@ -56,6 +58,12 @@ class Concourse
 
     @directory = options[:directory] || DEFAULT_DIRECTORY
     @fly_target = options[:fly_target] || DEFAULT_FLY_TARGET
+    @format = options.has_key?(:format) ? options[:format] : false
+    @fly_args = options.keys.grep(/^fly_args_/).inject({}) do |hash, key|
+      fly_command = key.to_s.gsub(/^fly_args_/, "").gsub("_", "-")
+      hash[fly_command] = options[key]
+      hash
+    end
 
     base_secrets_filename = options[:secrets_filename] || DEFAULT_SECRETS
     @secrets_filename = File.join(@directory, base_secrets_filename)
@@ -89,14 +97,15 @@ class Concourse
     File.open pipeline.filename, "w" do |f|
       f.write erbify_file(pipeline.erb_filename, working_directory: directory)
     end
-    fly "validate-pipeline -c #{pipeline.filename}"
+    fly "validate-pipeline", "-c #{pipeline.filename}"
+    fly "format-pipeline", "-c #{pipeline.filename} -w" if format
   end
 
   def ensure_docker_compose_file
     return if File.exist?(docker_compose_path)
     note "fetching docker compose file ..."
     File.open(docker_compose_path, "w") do |f|
-      f.write open("https://concourse-ci.org/docker-compose.yml").read
+      f.write URI.open("https://concourse-ci.org/docker-compose.yml").read
       sh "docker pull concourse/concourse"
     end
   end
@@ -104,7 +113,7 @@ class Concourse
   def rake_concourse_local
     ensure_docker_compose_file
     @fly_target = "local"
-    fly "login -u test -p test -c http://127.0.0.1:8080"
+    fly "login", "-u test -p test -c http://127.0.0.1:8080"
   end
 
   def rake_concourse_local_up
@@ -124,8 +133,6 @@ class Concourse
     end
 
     pipelines.each do |pipeline|
-      CLOBBER.include pipeline.filename if defined?(CLOBBER)
-
       unless File.exist? pipeline.erb_filename
         warn "WARNING: concourse template #{pipeline.erb_filename.inspect} does not exist, run `rake concourse:init`"
       end
@@ -167,7 +174,7 @@ class Concourse
             note "using #{secrets_filename} to resolve template vars in #{pipeline.filename}"
             options << "-l '#{secrets_filename}'"
           end
-          fly "set-pipeline #{options.join(" ")}"
+          fly "set-pipeline", options.join(" ")
         end
       end
 
@@ -178,18 +185,11 @@ class Concourse
         pipelines.each do |pipeline|
           desc "#{command} the #{pipeline.name} pipeline"
           task "#{command}:#{pipeline.name}" do
-            fly "#{command}-pipeline -p #{pipeline.name}"
+            fly "#{command}-pipeline", "-p #{pipeline.name}"
           end
         end
       end
 
-      desc "remove generated pipeline files"
-      task "clean" do
-        pipelines.each do |pipeline|
-          rm_f pipeline.filename
-        end
-      end
-
       #
       #  task commands
       #
@@ -229,8 +229,8 @@ class Concourse
         Tempfile.create("concourse-task") do |f|
           f.write concourse_task["config"].to_yaml
           f.close
-          Bundler.with_clean_env do
-            fly "execute #{fly_execute_args} -c #{f.path}"
+          Bundler.with_unbundled_env do
+            fly "execute", [fly_execute_args, "-c #{f.path}"].compact.join(" ")
           end
         end
       end
@@ -244,7 +244,7 @@ class Concourse
           pipeline_job, build_id, status = *line.split(/\s+/)[1, 3]
           next unless status == "started"
 
-          fly "abort-build -j #{pipeline_job} -b #{build_id}"
+          fly "abort-build", "-j #{pipeline_job} -b #{build_id}"
         end
       end
 
@@ -255,7 +255,7 @@ class Concourse
       task "prune-stalled-workers" do
         `fly -t #{fly_target} workers | fgrep stalled`.each_line do |line|
           worker_id = line.split.first
-          fly "prune-worker -w #{worker_id}"
+          fly "prune-worker", "-w #{worker_id}"
         end
       end
 

data/lib/concourse/util.rb

@@ -18,8 +18,9 @@ class Concourse
       File.open(GITIGNORE_FILE, "a") { |f| f.puts file_glob }
     end
 
-    def fly command
-      sh "fly -t #{fly_target} #{command}"
+    def fly command, args
+      command_args = Array(fly_args[command])
+      sh ["fly -t", fly_target, command, command_args, args].flatten.compact.join(" ")
     end
 
     def docker_compose command

data/lib/concourse/version.rb

@@ -2,5 +2,5 @@ require "rake"
 require "erb"
 
 class Concourse
-  VERSION = "0.31.0"
+  VERSION = "0.36.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concourse
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.36.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor