concourse 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb089c5d0c00bb5be8d5097ea5f37fb094ab74f989818689eb9c1de7d83d82fb
-  data.tar.gz: f7686235e1d556de60df126dd75ac7e35d20c60ef38226815ad86b96c72016d6
+  metadata.gz: bdb08ded6bc7add4c5b21fa081ceb9a52283c9081bf7ae1094c5a48b7f1758fa
+  data.tar.gz: 0a0c4cc019356a598654b19a27be40586fcc07f56c4ef21f96974e0596c1c6ca
 SHA512:
-  metadata.gz: a98c31ed037531d1c32553d2120df82558adab706045b8fa8206a8642210b584d129debab2a0c3cd4c180aa4e8c2e38c3b6fa223950d46bf6afe23b96ae7b786
-  data.tar.gz: 4efb7ed63f37ab78a92c8f0711fff8f34f31f10fedb8789ab32f9921f1665ee542e3f3a0b590df0f75d1677e07af321a0e5c8f4fd881386f7659ba1640e76e1f
+  metadata.gz: 0db62a2d34244fa3299b762b18ce9b2d16923b490b8c3ecef41c441f127c0d04d870045fac6ceb9ef1f895b0a2dda2650785f980915f28b3462dbc079ce486ce
+  data.tar.gz: 861dbb07056210372edd4e0f4dc371bf76f7851a56839f82756727400884c5dbd68e6c47cb013a27d846ce504d8655300fcea58dc7761bfa621559f2245149b2

data/CHANGELOG.md

@@ -1,20 +1,33 @@
 # concourse-gem changelog
 
-## 0.26.0 / 2019-02-02
+## v0.27.0 / 2019-04-28
+
+### Features
+
+* Provide description for the `concourse:local` rake task.
+* `concourse:task` resolves private variables.
+
+
+### Bug fixes
+
+* Update error message for `concourse:task` task to match actual args.
+
+
+## v0.26.0 / 2019-02-02
 
 ### Breaking changes
 
 * Generated pipeline files are no longer `.gitignore`d.
 
 
-## 0.25.0 / 2019-02-02
+## v0.25.0 / 2019-02-02
 
 ### Features
 
 * Support running a local ephemeral Concourse cluster with `docker-compose`.
 
 
-## 0.24.0 / 2019-01-24
+## v0.24.0 / 2019-01-24
 
 ### Features
 
@@ -27,14 +40,14 @@
 * `#erbify` has been removed in favor of `#erbify_file`
 
 
-## 0.23.0 / 2019-01-19
+## v0.23.0 / 2019-01-19
 
 ### Features
 
 * Support for multiple pipelines.
 
 
-## 0.22.0 / 2019-01-18
+## v0.22.0 / 2019-01-18
 
 ### Breaking changes
 
@@ -49,18 +62,18 @@
 * `Concourse.new` now takes an optional `:secrets_filename` named param to set the name of the private variable file used. [#1] (Thanks, @ebmeierj!)
 
 
-## 0.21.0 / 2018-12-26
+## v0.21.0 / 2018-12-26
 
 * Introduce ruby 2.6 final (and remove 2.6-rc)
 
 
-## 0.20.0 / 2018-11-09
+## v0.20.0 / 2018-11-09
 
 * Introduce ruby 2.6-rc
 * Introduce helper methods `production_rubies` and `rc_rubies`
 
 
-## 0.19.0 / 2018-09-15
+## v0.19.0 / 2018-09-15
 
 Several version of Ruby have reached EOL and have been removed from `RUBIES`:
 
@@ -69,41 +82,41 @@ Several version of Ruby have reached EOL and have been removed from `RUBIES`:
 - jruby 1.7: https://github.com/jruby/jruby/issues/4112
 
 
-## 0.18.0 / 2018-02-18
+## v0.18.0 / 2018-02-18
 
 * Better default for `input` args to `concourse:task`: use the local directory for all the inputs. This matches the pattern where two different resources are used for ci scripts and the source under test.
 
 
-## 0.17.0 / 2017-09-24
+## v0.17.0 / 2017-09-24
 
 * Add support for Ruby 2.5 (in general and on Windows)
 * Remove `fly` `-x` argument to work with Concourse 3.7.0+
 
 
-## 0.16.0 / 2017-09-24
+## v0.16.0 / 2017-09-24
 
 Bugfix: require "tempfile", we've been relying on the class being implicitly loaded
 
 
-## 0.15.0 / 2017-09-24
+## v0.15.0 / 2017-09-24
 
 * Add awareness of Windows Rubies (implicitly linked with https://github.com/flavorjones/windows-ruby-dev-tools-release)
 
 
-## 0.14.0 / 2017-04-23
+## v0.14.0 / 2017-04-23
 
 * Removed badge functionality. IMHO: too complicated, not useful
 * Restoring support for Ruby 1.9 (for JRuby 1.7), ugh.
 
 
-## 0.13.0 / 2017-03-23
+## v0.13.0 / 2017-03-23
 
 ### Features
 
 * allow setting of concourse directory name
 
 
-## 0.12.0 / 2017-02-14
+## v0.12.0 / 2017-02-14
 
 ### Features
 
@@ -114,56 +127,56 @@ Bugfix: require "tempfile", we've been relying on the class being implicitly loa
 * properly require 'yaml'
 
 
-## 0.11.0 / 2017-02-14
+## v0.11.0 / 2017-02-14
 
 Stop using `myproject.yml.erb` and just interpret `myproject.yml` as an ERB template. @jtarchie was right. He's always right.
 
 
-## 0.10.0 / 2017-02-08
+## v0.10.0 / 2017-02-08
 
 Add `destroy` and `abort-builds` tasks.
 
 
-## 0.9.0 / 2017-02-08
+## v0.9.0 / 2017-02-08
 
 Bugfix: run `fly execute` with a clean Bundler environment, to avoid accidentally injecting our environment variables into the running task.
 
 
-## 0.8.0 / 2017-02-08
+## v0.8.0 / 2017-02-08
 
 Expose `#erbify` and `#markdown_badge` methods.
 
 
-## 0.7.0 / 2017-02-08
+## v0.7.0 / 2017-02-08
 
 Added a rake task to generate badges markdown.
 
 
-## 0.6.{0,1} / 2017-01-26
+## v0.6.{0,1} / 2017-01-26
 
 If it exists, use `concourse/private.yml` to fill in template values.
 
 
-## 0.5.0 / 2017-01-23
+## v0.5.0 / 2017-01-23
 
 Renamed the `concourse:tasks` task name arg, and improved the README.
 
 
-## 0.4.0 / 2017-01-22
+## v0.4.0 / 2017-01-22
 
 Now uses the project name as the `fly execute` input resource name.
 
 
-## 0.3.0 / 2017-01-22
+## v0.3.0 / 2017-01-22
 
 Avoid depending on `rake/clean`
 
 
-## 0.2.0 / 2017-01-22
+## v0.2.0 / 2017-01-22
 
 Always regenerate pipeline file.
 
 
-## 0.1.0 / 2017-01-22
+## v0.1.0 / 2017-01-22
 
 First release.

data/README.md

@@ -1,8 +1,12 @@
 # concourse (the rubygem)
 
-The `concourse` gem provides rake tasks to help you manage Concourse pipelines, jobs, and workers, to assist in running tasks with `fly execute`, and even run a local ephemeral deployment of Concourse on your development machine.
+The `concourse` gem provides rake tasks to help you manage Concourse CI pipelines, jobs, and workers, to assist in running tasks with `fly execute`, and even run a local ephemeral deployment of Concourse on your development machine.
 
-If you're not familiar with Concourse CI, you can read up on it at https://concourse.ci
+If you're not familiar with Concourse CI, you can read up on it at https://concourse-ci.org
+
+Here's an example pipeline maintained by this gem:
+
+![nokogiri-master](assets/nokogiri-master-pipeline.png)
 
 
 ## Contents
@@ -15,6 +19,7 @@ If you're not familiar with Concourse CI, you can read up on it at https://conco
   * [Install](#install)
   * [Add to your `Rakefile`](#add-to-your-rakefile)
   * [Set up your Concourse pipeline](#set-up-your-concourse-pipeline)
+- [Real-world Examples](#real-world-examples)
 - [Concourse pipeline configuration](#concourse-pipeline-configuration)
   * [ERB Templating](#erb-templating)
   * [`RUBIES`](#rubies)
@@ -78,6 +83,18 @@ The `concourse:init` task will do a few different things for you:
 3. ensure git will ignore your secrets file named `private.yml` (or whatever you've configured with the `:secrets_filename` parameter)
 
 
+## Real-world Examples
+
+It might be helpful to look at how other projects are using this gem. Here are a sample, ordered (approximately) from simplest to most complex:
+
+* [`jbarnette/hoe-debugging`](https://github.com/jbarnette/hoe-debugging) has [one pipeline](https://github.com/jbarnette/hoe-debugging/blob/master/concourse/hoe-debugging.yml) that test multiple versions of MRI. ([see it live](https://ci.nokogiri.org/teams/flavorjones/pipelines/hoe-debugging))
+* [`flavorjones/hoe-gemspec`](https://github.com/flavorjones/hoe-gemspec) has [one pipeline](https://github.com/flavorjones/hoe-gemspec/blob/master/concourse/hoe-gemspec.yml) that test multiple versions of MRI __and JRuby__. ([see it live](https://ci.nokogiri.org/teams/flavorjones/pipelines/hoe-gemspec))
+* [`flavorjones/calendar-assistant`](https://github.com/flavorjones/calendar-assistant) has [one pipeline](https://github.com/flavorjones/calendar-assistant/blob/master/concourse/calendar-assistant.yml) that runs tests against `master` __and pull-requests__, uses __secrets__, and __integrates with Slack__. ([see it live](https://ci.nokogiri.org/teams/calendar-assistants/pipelines/calendar-assistant))
+* [`flavorjones/mini_portile`](https://github.com/flavorjones/mini_portile) has [one pipeline](https://github.com/flavorjones/mini_portile/blob/master/concourse/mini_portile.yml) that run tests on both Linux __and Windows__. ([see it live](https://ci.nokogiri.org/teams/nokogiri-core/pipelines/mini_portile))
+* [`flavorjones/chromedriver-helper`](https://github.com/flavorjones/chromedriver-helper) has __two pipelines__ that test [master](https://github.com/flavorjones/chromedriver-helper/blob/master/concourse/chromedriver-helper.yml) and [pull requests](https://github.com/flavorjones/chromedriver-helper/blob/master/concourse/chromedriver-helper-pr.yml). (see [Rakefile](https://github.com/flavorjones/chromedriver-helper/blob/master/Rakefile#L9-L12) config) (see [master](https://ci.nokogiri.org/teams/flavorjones/pipelines/chromedriver-helper) and [PR](https://ci.nokogiri.org/teams/flavorjones/pipelines/chromedriver-helper-pr) pipelines live)
+* [`sparklemotion/nokogiri`](https://github.com/sparklemotion/nokogiri) has [multiple pipelines](https://github.com/sparklemotion/nokogiri/blob/master/concourse/nokogiri.yml) that __use `require` and `erbify_file` to share common elements__, and __integrate with IRC__. (see [master](https://ci.nokogiri.org/teams/nokogiri-core/pipelines/nokogiri) and [PR](https://ci.nokogiri.org/teams/nokogiri-core/pipelines/nokogiri-pr) pipelines live)
+
+
 ## Concourse pipeline configuration
 
 ### ERB Templating
@@ -110,10 +127,10 @@ The ruby variable `RUBIES` is defined in the ERB binding during pipeline file ge
 ``` ruby
   # these numbers/names align with public docker image names
   RUBIES = {
-    mri:     %w[2.1 2.2 2.3 2.4], # docker repository: "ruby"
-    jruby:   %w[1.7 9.1],         # docker repository: "jruby"
-    rbx:     %w[latest],          # docker repository: "rubinius/docker"
-    windows: %w[2.3 2.4]          # windows-ruby-dev-tools-release
+    mri:     %w[2.3 2.4 2.5 2.6], # docker repository: "ruby"
+    jruby:   %w[9.1 9.2],     # docker repository: "jruby"
+    rbx:     %w[latest],      # docker repository: "rubinius/docker"
+    windows: %w[2.3 2.4 2.5 2.6]  # windows-ruby-dev-tools-release
   }
 ```
 
@@ -122,14 +139,18 @@ and allows you to write a pipeline like this to get coverage on all the supporte
 ``` yaml
 # myproject.yml
 jobs:
-  <% for ruby_version in RUBIES[:mri] %>
+% RUBIES[:mri].each do |ruby_version|
   - name: "ruby-<%= ruby_version %>"
     plan:
-      - get: git-master
-        trigger: true
+      ...
       - task: rake-test
+        config:
+          platform: linux
+          image_resource:
+            type: docker-image
+            source: {repository: "ruby", tag: "<%= ruby_version %>"}
     ...
-  <% end %>
+% end
 ```
 
 Note that the `windows` rubies are not Docker images, since Concourse's Houdini backend doesn't use Docker. Instead, these are implicitly referring to the supported ruby versions installed by the BOSH release at https://github.com/flavorjones/windows-ruby-dev-tools-release

data/lib/concourse.rb

@@ -11,10 +11,10 @@ class Concourse
 
   # these numbers/names align with public docker image names
   RUBIES = {
-    mri:     %w[2.3 2.4 2.5 2.6], # docker repository: "ruby"
-    jruby:   %w[9.1 9.2],     # docker repository: "jruby"
-    rbx:     %w[latest],      # docker repository: "rubinius/docker"
-    windows: %w[2.3 2.4 2.5 2.6]  # windows-ruby-dev-tools-release
+    mri: %w[2.3 2.4 2.5 2.6], # docker repository: "ruby"
+    jruby: %w[9.1 9.2],     # docker repository: "jruby"
+    rbx: %w[latest],      # docker repository: "rubinius/docker"
+    windows: %w[2.3 2.4 2.5 2.6],  # windows-ruby-dev-tools-release
   }
 
   DEFAULT_DIRECTORY = "concourse"
@@ -29,13 +29,13 @@ class Concourse
 
   CONCOURSE_DOCKER_COMPOSE = "docker-compose.yml"
 
-  def self.url_for fly_target
+  def self.url_for(fly_target)
     matching_line = `fly targets`.split("\n").grep(/^#{fly_target}/).first
     raise "invalid fly target #{fly_target}" unless matching_line
     matching_line.split(/ +/)[1]
   end
 
-  def self.default_execute_args task
+  def self.default_execute_args(task)
     args = []
     task["config"]["inputs"].each do |input|
       args << "--input=#{input["name"]}=."
@@ -51,7 +51,7 @@ class Concourse
     RUBIES[:mri].select { |r| r =~ /rc/ }
   end
 
-  def initialize project_name, options={}, &block
+  def initialize(project_name, options = {}, &block)
     @project_name = project_name
 
     @directory = options[:directory] || DEFAULT_DIRECTORY
@@ -69,11 +69,11 @@ class Concourse
     end
   end
 
-  def add_pipeline name, erb_filename
+  def add_pipeline(name, erb_filename)
     @pipelines << Concourse::Pipeline.new(name, @directory, erb_filename)
   end
 
-  def pipeline_subcommands command
+  def pipeline_subcommands(command)
     pipelines.collect { |p| "#{command}:#{p.name}" }
   end
 
@@ -85,19 +85,13 @@ class Concourse
     ensure_in_gitignore secrets_filename
   end
 
-  def rake_pipeline_generate pipeline
+  def rake_pipeline_generate(pipeline)
     File.open pipeline.filename, "w" do |f|
       f.write erbify_file(pipeline.erb_filename, working_directory: directory)
     end
     fly "validate-pipeline -c #{pipeline.filename}"
   end
 
-  def rake_concourse_local
-    ensure_docker_compose_file
-    @fly_target = "local"
-    fly "login -u test -p test -c http://127.0.0.1:8080"
-  end
-
   def ensure_docker_compose_file
     return if File.exist?(docker_compose_path)
     note "fetching docker compose file ..."
@@ -106,6 +100,12 @@ class Concourse
     end
   end
 
+  def rake_concourse_local
+    ensure_docker_compose_file
+    @fly_target = "local"
+    fly "login -u test -p test -c http://127.0.0.1:8080"
+  end
+
   def rake_concourse_local_up
     ensure_docker_compose_file
     docker_compose "up -d"
@@ -210,7 +210,7 @@ class Concourse
       task "task", [:job_task, :fly_execute_args] => "generate" do |t, args|
         job_task = args[:job_task]
         unless job_task
-          raise "ERROR: must specify a task name, like `rake #{t.name}[target,taskname]`"
+          raise "ERROR: must specify a task name, like `rake #{t.name}[taskname]`"
         end
 
         concourse_task = find_task(job_task)
@@ -218,7 +218,13 @@ class Concourse
 
         fly_execute_args = args[:fly_execute_args] || Concourse.default_execute_args(concourse_task)
 
+        if File.exist? secrets_filename
+          note "using #{secrets_filename} to resolve template vars"
+          fly_execute_args += " -l '#{secrets_filename}'"
+        end
+
         puts concourse_task.to_yaml
+
         Tempfile.create("concourse-task") do |f|
           f.write concourse_task["config"].to_yaml
           f.close
@@ -234,7 +240,7 @@ class Concourse
       desc "abort all running builds for this concourse team"
       task "abort-builds" do |t, args|
         `fly -t #{fly_target} builds`.each_line do |line|
-          pipeline_job, build_id, status = *line.split(/\s+/)[1,3]
+          pipeline_job, build_id, status = *line.split(/\s+/)[1, 3]
           next unless status == "started"
 
           fly "abort-build -j #{pipeline_job} -b #{build_id}"
@@ -255,6 +261,7 @@ class Concourse
       #
       #  docker commands
       #
+      desc "set fly target to the local docker-compose cluster"
       task "local" do
         rake_concourse_local
       end

data/lib/concourse/version.rb

@@ -2,5 +2,5 @@ require "rake"
 require "erb"
 
 class Concourse
-  VERSION = "0.26.0"
+  VERSION = "0.27.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concourse
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-02 00:00:00.000000000 Z
+date: 2019-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
@@ -82,6 +82,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/nokogiri-master-pipeline.png
 - concourse.gemspec
 - lib/concourse.rb
 - lib/concourse/pipeline.rb
@@ -106,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rake tasks for Concourse pipelines.