concourse 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50517da26e0d7eb88bb231814b9a664ee17bc5e08c278eb2724e472797832867
-  data.tar.gz: 7c0ce4a2fc2844bf187ba242d47c62c5b1ab684ef85d6194520c90807b10b8c3
+  metadata.gz: 69454c7a7cfcaa97aa0ae0e60154643107ec31e27f4870fb2c03e3cb5cf8e53a
+  data.tar.gz: b2d936d3806d0725a78549f984b5d25bd0bb02bb171d6cbcb13b47ecf0c61bf3
 SHA512:
-  metadata.gz: c19043e491bd57cfc3f57babcc494ac0eee2e35e501f3a45e076af6655c8b94940f89ece2d7b067f762039a0723031e3329c2b635525927bf0a40202158727be
-  data.tar.gz: fb3024061b013b796d65e68757cb9aade22126868d7c3c29be367c0ac39142da96c3024575c7753f5c3909f67d53104cb25c5eb1fd85a8a283c99b8ddc41c7f2
+  metadata.gz: 279c5aea4104ccb041bbfa02700625356dc31dbdf2e21f0c9f2cdd928883108f55f149609f06cc7e7a174434abc899760e744c50423ebca1753ab514fae52130
+  data.tar.gz: d298b46e242c2230984d7b7e503fd82ab6fd4ff6aa6d1b2803e6fd9731fa5733f1ac27ae53f7a6050c73269d9fb193b5f18f7f0b0581f2f194e6e07b52f03f93

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # concourse-gem changelog
 
+## 0.24.0 / 2019-01-24
+
+### Features
+
+* `$LOAD_PATH` includes the concourse directory, so that `require` will find relative filepaths.
+* `erbify_file` method may be called to recursively include yaml erb templates.
+
+
+### Breaking changes
+
+* `#erbify` has been removed in favor of `#erbify_file`
+
+
 ## 0.23.0 / 2019-01-19
 
 ### Features

data/README.md

@@ -16,7 +16,8 @@ If you're not familiar with Concourse CI, you can read up on it at https://conco
   * [Add to your `Rakefile`](#add-to-your-rakefile)
   * [Set up your Concourse pipeline](#set-up-your-concourse-pipeline)
 - [Concourse pipeline configuration](#concourse-pipeline-configuration)
-  * [ERB Templating and `RUBIES`](#erb-templating-and-rubies)
+  * [ERB Templating](#erb-templating)
+  * [`RUBIES`](#rubies)
   * [Secrets](#secrets)
   * [Multiple pipelines](#multiple-pipelines)
 - [Configuration](#configuration)
@@ -76,12 +77,31 @@ The `concourse:init` task will do a few different things for you:
 
 ## Concourse pipeline configuration
 
-### ERB Templating and `RUBIES`
+### ERB Templating
 
 Your Concourse pipeline configuration file, `<myproject>.yml` (or whatever you've configured with the `:pipeline_erb_filename` parameter), will be treated like an ERB template.
 
+The concourse directory is added the `$LOAD_PATH` and so local ruby files may be `require`d if you so desire. Also note that you can include other yaml erb snippets with the method `erbify_file`.
+
+An example using both of these features:
+
+``` yaml
+% require "common_prelude" #  will find "common_prelude.rb" in the concourse directory
+
+resources:
+<%= erbify_file "common_resources.yml" -%> #  will find this file in the concourse directory and recursively erbify it
+  - name: resource_unique_to_this_pipeline
+    type: git
+    source:
+      uri: <%= $common_prelude_defined_uri_prefix %>/username/projectname.git
+      branch: master
+```
+
 (If you're unfamiliar with ERB and how you can mix Ruby into the document, you can [read about it here](https://www.stuartellis.name/articles/erb/).)
 
+
+### `RUBIES`
+
 The ruby variable `RUBIES` is defined in the ERB binding during pipeline file generation. This variable looks like:
 
 ``` ruby
@@ -211,33 +231,33 @@ Tasks to manage a local pipeline file, generated from an ERB template:
 
 ```
 rake concourse:clean     # remove generated pipeline files
-rake concourse:generate  # generate and validate the pipeline files for myproject
+rake concourse:generate  # generate and validate all pipeline files
 ```
 
 A task to update your pipeline configuration:
 
 ```
-rake concourse:set       # upload the pipeline files for myproject
+rake concourse:set       # upload all pipeline files
 ```
 
 Tasks to publicly expose or hide your pipeline:
 
 ```
-rake concourse:expose    # expose the myproject pipelines
-rake concourse:hide      # hide the myproject pipelines
+rake concourse:expose    # expose all pipelines
+rake concourse:hide      # hide all pipelines
 ```
 
 Tasks to pause and unpause your pipeline:
 
 ```
-rake concourse:pause     # pause the myproject pipelines
-rake concourse:unpause   # unpause the myproject pipelines
+rake concourse:pause     # pause all pipelines
+rake concourse:unpause   # unpause all pipelines
 ```
 
 And, should you ever need to [nuke the site from orbit][ripley], a task to destroy your pipeline:
 
 ```
-rake concourse:destroy   # destroy the myproject pipelines
+rake concourse:destroy   # destroy all pipelines
 ```
 
   [ripley]: https://www.youtube.com/watch?v=aCbfMkh940Q
@@ -248,7 +268,7 @@ rake concourse:destroy   # destroy the myproject pipelines
 You can see a list of all the tasks defined in your pipelines:
 
 ```
-rake concourse:tasks  # list all the available tasks from the myproject pipelines
+rake concourse:tasks  # list all available tasks from all pipelines
 ```
 
 You'll see output suitable for the `concourse:task` rake task, formatted as `job-name/task-name`, looking something like:

data/lib/concourse.rb

@@ -81,6 +81,13 @@ class Concourse
     ensure_in_gitignore secrets_filename
   end
 
+  def rake_pipeline_generate pipeline
+    File.open pipeline.filename, "w" do |f|
+      f.write erbify_file(pipeline.erb_filename, working_directory: directory)
+    end
+    sh "fly validate-pipeline -c #{pipeline.filename}"
+  end
+
   def create_tasks!
     unless Dir.exist? directory
       mkdir_p directory
@@ -112,10 +119,7 @@ class Concourse
       pipelines.each do |pipeline|
         desc "generate and validate the #{pipeline.name} pipeline file"
         task "generate:#{pipeline.name}" do
-          File.open pipeline.filename, "w" do |f|
-            f.write erbify(File.read(pipeline.erb_filename))
-          end
-          sh "fly validate-pipeline -c #{pipeline.filename}"
+          rake_pipeline_generate pipeline
         end
       end
 
@@ -159,7 +163,7 @@ class Concourse
       #
       #  task commands
       #
-      desc "list all the available tasks from the #{project_name} pipelines"
+      desc "list all available tasks from all pipelines"
       task "tasks" => "generate" do
         tasks = []
 

data/lib/concourse/util.rb

@@ -20,7 +20,7 @@ class Concourse
 
     def sh command
       running "(in #{Dir.pwd}) #{command}"
-      super command, verbose: false
+      Rake.sh command, verbose: false
     end
 
     def running message
@@ -31,8 +31,17 @@ class Concourse
       print bold, green, "NOTE: ", reset, message, "\n"
     end
 
-    def erbify document_string, *args
-      ERB.new(document_string, nil, "%-").result(binding)
+    def erbify_file filename, working_directory: nil
+      raise "ERROR: erbify_file: could not find file `#{filename}`" unless File.exist?(filename)
+      template = File.read(filename)
+
+      if working_directory.nil?
+        working_directory = "." # so chdir is a no-op below
+      else
+        fqwd = File.expand_path(working_directory)
+        $LOAD_PATH << fqwd unless $LOAD_PATH.include?(fqwd) # so "require" can load relative paths
+      end
+      Dir.chdir(working_directory) { ERB.new(template, nil, "%-").result(binding) }
     end
 
     def each_job pipeline

data/lib/concourse/version.rb

@@ -2,5 +2,5 @@ require "rake"
 require "erb"
 
 class Concourse
-  VERSION = "0.23.0"
+  VERSION = "0.24.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concourse
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-19 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor