concourse 0.38.0 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4545117f3a9ab7e87861ed9d985f4ce559ef5636ab4c90f9dc72d0415a53f65d
-  data.tar.gz: d15f26777dff8e5f63e0da5ffbab5e036b83381680bb3782039843a323dab64e
+  metadata.gz: cd55e825ebdac1ac76b5d97ac48b4ddbf7dc8771e6e6a1855bb38ed9dde92a99
+  data.tar.gz: db17dddab390c5755e8954e30ed4b91bbde773afe7a8a17b0f526368c8af7391
 SHA512:
-  metadata.gz: d3c56b95c58c91946b229e17f46adb1131268354100fc346ac98829db3c17e056c4f2c70ebad9dd8cafc5dd2f8c2b8d2e038e413d0d5404782bc078b4a8d94d7
-  data.tar.gz: fff0b1b7943cb4fc1fbd67a3c2a4360682718eefa0baca151a09f694ccb41882eeeecb58fe6742e32f6e2d1d02a8eef2dfbaeba06137dfa56304467d193543c2
+  metadata.gz: 5c7f87dd6367321ab38c19881905a472b68c987199d6601817468cd171653a41ed37be9cb9f40bec19577c2daabe079eaa380e6b5106f57e50a56febba584720
+  data.tar.gz: 8c489739957e3a872f85345d7376e403464b0545548eaf296d0a549d3056113f8d6a350efc6157cf1e8181791f1184247958a096f46b0198fe1954c0f332346b

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # concourse-gem changelog
 
+## v0.39.0 / 2020-11-16
+
+* add support for [YTT](https://get-ytt.io/) pipeline templates
+
+
 ## v0.38.0 / 2020-10-01
 
 * add ruby 3.0-rc

data/README.md

@@ -22,12 +22,14 @@ Here's an example pipeline maintained by this gem:
 - [Real-world Examples](#real-world-examples)
 - [Concourse pipeline configuration](#concourse-pipeline-configuration)
   * [ERB Templating](#erb-templating)
-  * [`RUBIES`](#rubies)
+  * [YTT Templating](#ytt-templating)
+  * [Mixing ERB and YTT Templating](#mixing-erb-and-ytt-templating)
   * [Secrets](#secrets)
   * [Multiple pipelines](#multiple-pipelines)
 - [Configuration](#configuration)
   * [`directory`: Concourse subdirectory name](#directory-concourse-subdirectory-name)
   * [`fly_target`: Concourse `fly` target name](#fly_target-concourse-fly-target-name)
+  * [`ytt`: boolean, or a YTT configuration directory name](#ytt-boolean-or-a-ytt-configuration-directory-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)
@@ -122,7 +124,7 @@ resources:
 (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`
+#### `RUBIES`
 
 The ruby variable `RUBIES` is defined in the ERB binding during pipeline file generation. This variable looks like:
 
@@ -158,6 +160,71 @@ jobs:
 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
 
 
+### YTT Templating
+
+As of v0.39.0, YTT templates are also supported. It's off by default, but you can enable it by passing `ytt: true` to the `Concourse.new` or `Concourse#add_pipeline` calls in your Rakefile (see below for more context).
+
+Your Concourse pipeline configuration file, `<myproject>.yml` (or whatever you've configured with the `:pipeline_erb_filename` parameter), will be treated like a YTT template.
+
+You can optionally specify a directory containing your YTT configuration files (`.star` files and `.yml` templates) so that you can inject project-specific logic.
+
+(If you're unfamiliar with YTT, you can [read about it here](https://get-ytt.io/).)
+
+
+#### Rubies
+
+These YTT variables are defined by the gem, and can be used in your template:
+
+```starlark
+#! ruby.star
+cruby_versions = {
+    "supported": ["2.4", "2.5", "2.6", "2.7"],
+    "out_of_support": ["2.3", "2.2", "2.1", "2.0.0"],
+    "beta": ["3.0-rc"]
+}
+jruby_versions = {
+    "supported": ["9.2"],
+    "out_of_support": ["9.1"],
+    "beta": []
+}
+truffleruby_versions = {
+    "supported": ["stable"],
+    "out_of_support": [],
+    "beta": ["nightly"]
+}
+```
+
+Here's a simple example:
+
+``` yaml
+# myproject.yml
+
+#@ load("ruby.star", "cruby_versions")
+
+---
+jobs:
+#@ for ruby_version in cruby_versions["supported"]:
+  - name: #@ "ruby-{}".format(ruby_version)
+    plan:
+      ...
+      - task: rake-test
+        config:
+          platform: linux
+          image_resource:
+            type: docker-image
+            source:
+              repository: "ruby"
+              tag: #@ "mri-{}".format(ruby_version)
+    ...
+#@ end
+```
+
+
+### Mixing ERB and YTT Templating
+
+Why would you do this? Well, if you really want to, I'll tell you a secret: we treat the YTT templates as though they're *also* ERB templates. So go crazy.
+
+
 ### Secrets
 
 You can use a separate file to keep your pipeline variables secret. By default, `concourse/private.yml` will be used. This filename can also be configured (see below)
@@ -206,6 +273,10 @@ Note that when you use the block form:
 * it's not necessary to explicitly call `#create_tasks!`
 * only the pipelines declared via `#add_pipeline` will be managed
 
+Note also that `Concourse#add_pipeline` takes additional options:
+
+* `ytt`: same as the global `ytt` configuration below
+
 
 ## Configuration
 
@@ -227,6 +298,15 @@ Concourse.new("myproject", fly_target: "myci").create_tasks! # `fly -t myci <com
 ```
 
 
+### `ytt`: Enable YTT templating
+
+By default, this option is `false` and pipelines are treated as ERB templates.
+
+Setting this to `true` will run the file through first ERB (which will be a no-op if you're not using ERB) and then through YTT.
+
+Setting this to a `String` argument containing a directory path will cause YTT to be invoked with a `-f` option loading that directory.
+
+
 ### `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!

data/lib/concourse.rb

@@ -29,6 +29,7 @@ class Concourse
   attr_reader :fly_args
   attr_reader :secrets_filename
   attr_reader :format
+  attr_reader :ytt
 
   CONCOURSE_DOCKER_COMPOSE = "docker-compose.yml"
 
@@ -60,6 +61,7 @@ class Concourse
     @directory = options[:directory] || DEFAULT_DIRECTORY
     @fly_target = options[:fly_target] || DEFAULT_FLY_TARGET
     @format = options.has_key?(:format) ? options[:format] : false
+    @ytt = options.has_key?(:ytt) ? options[:ytt] : 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]
@@ -74,12 +76,12 @@ class Concourse
       block.call(self)
       create_tasks!
     else
-      add_pipeline(@project_name, (options[:pipeline_erb_filename] || "#{project_name}.yml"))
+      add_pipeline(@project_name, (options[:pipeline_erb_filename] || "#{project_name}.yml"), {ytt: ytt})
     end
   end
 
-  def add_pipeline(name, erb_filename)
-    @pipelines << Concourse::Pipeline.new(name, @directory, erb_filename)
+  def add_pipeline(name, erb_filename, options={})
+    @pipelines << Concourse::Pipeline.new(name, @directory, erb_filename, options)
   end
 
   def pipeline_subcommands(command)
@@ -95,9 +97,7 @@ class Concourse
   end
 
   def rake_pipeline_generate(pipeline)
-    File.open pipeline.filename, "w" do |f|
-      f.write erbify_file(pipeline.erb_filename, working_directory: directory)
-    end
+    pipeline.generate
     fly "validate-pipeline", "-c #{pipeline.filename}"
     fly "format-pipeline", "-c #{pipeline.filename} -w" if format
   end

data/lib/concourse/pipeline.rb

@@ -1,12 +1,31 @@
 class Concourse
   class Pipeline
-    attr_reader :name, :directory, :erb_filename, :filename
+    include Concourse::Util
 
-    def initialize name, directory, erb_filename
+    attr_reader :name, :directory, :erb_filename, :filename, :ytt
+
+    def initialize name, directory, erb_filename, options={}
       @name = name
       @directory = directory
       @erb_filename = File.join(@directory, erb_filename)
       @filename = File.join(@directory, erb_filename + ".generated")
+      @ytt = options.key?(:ytt) ? options[:ytt] : false
+    end
+
+    def generate
+      Tempfile.create(["pipeline", ".yml"]) do |f|
+        f.write erbify_file(erb_filename, working_directory: directory)
+        f.close
+
+        if ytt
+          ytt_args = ["-f #{f.path}"]
+          ytt_args << "-f #{File.expand_path(File.join(File.dirname(__FILE__), "ytt"))}"
+          ytt_args << "-f #{File.join(directory, ytt)}" if ytt.is_a?(String)
+          sh ["ytt", ytt_args, "> #{filename}"].flatten.join(" ")
+        else
+          FileUtils.mv f.path, filename, force: true
+        end
+      end
     end
   end
 end

data/lib/concourse/version.rb

@@ -2,5 +2,5 @@ require "rake"
 require "erb"
 
 class Concourse
-  VERSION = "0.38.0"
+  VERSION = "0.39.0"
 end

data/lib/concourse/ytt/ruby.star

@@ -0,0 +1,15 @@
+cruby_versions = {
+    "supported": ["2.4", "2.5", "2.6", "2.7"],
+    "out_of_support": ["2.3", "2.2", "2.1", "2.0.0"],
+    "beta": ["3.0-rc"]
+}
+jruby_versions = {
+    "supported": ["9.2"],
+    "out_of_support": ["9.1"],
+    "beta": []
+}
+truffleruby_versions = {
+    "supported": ["stable"],
+    "out_of_support": [],
+    "beta": ["nightly"]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: concourse
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.39.0
 platform: ruby
 authors:
 - Mike Dalessio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
@@ -88,6 +88,7 @@ files:
 - lib/concourse/pipeline.rb
 - lib/concourse/util.rb
 - lib/concourse/version.rb
+- lib/concourse/ytt/ruby.star
 homepage: https://github.com/flavorjones/concourse-gem
 licenses:
 - MIT
@@ -107,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Rake tasks for Concourse pipelines.