concourse 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee85690e2cce2d85793daef276bdeb5414374e88
-  data.tar.gz: 39aedca58ff45e15261c79338eb865762db466f0
+  metadata.gz: cb83feeb6f40bcd3a194cb889cd7e8e65f43ff64
+  data.tar.gz: 424a8885d44e16eea6e702237f98cbdb5c55e041
 SHA512:
-  metadata.gz: 7b538ca79abc181a43f5d0b9e6cfa81a867ca6ebbff301b3679222f90301ce9360a9c958686d7b1dcdfb010eb80fac87c61fe6a52293000833c0fd4feb36d84f
-  data.tar.gz: 54e97a66e38414343ee06b6cd2c6896d2ba58bfca504e67de7c1cfc0418b4e0d4b9cd5526c164b8252974dde51f5b24e2b778927ef4219575d73358f58e97842
+  metadata.gz: 3d90b8f93734761e7241823c9375328f3126a21a6784772308c32305650030754fbc952f4f2cb32143c2207c8b2c54d468d9b8bcd1388f7253661ad23679f199
+  data.tar.gz: 43d44fcaa6c2af3d5c879aeb46473a1997698bd19653c6d2c12f48dda0e179b7e8eef8b43a5defc9480d2d39d19fa62f2db56874a9a811f6564d65bbf00f905d

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # concourse-gem changelog
 
+## 0.5.0 / 2017-01-23
+
+Renamed the `concourse:tasks` task name arg, and improved the README.
+
+
+## 0.4.0 / 2017-01-22
+
+Now uses the project name as the `fly execute` input resource name.
+
+
+## 0.3.0 / 2017-01-22
+
+Avoid depending on `rake/clean`
+
+
 ## 0.2.0 / 2017-01-22
 
 Always regenerate pipeline file.

data/README.md

@@ -1,6 +1,6 @@
 # Concourse
 
-The `Concourse` gem creates rake tasks to help you manage your Concourse pipelines, and to assist in running individual tasks on your local development machine.
+The `Concourse` gem provides rake tasks to help you manage your Concourse pipelines, and to assist in running individual tasks with `fly execute`.
 
 If you're not familiar with Concourse CI, you can read up on it at https://concourse.ci
 
@@ -17,6 +17,42 @@ Concourse.new("myproject").create_tasks!
 
 This will create a set of rake tasks for you.
 
+Create a subdirectory named `concourse`, and edit a Concourse pipeline template named `myproject.yml.erb`.
+
+
+### Templating and `RUBIES`
+
+The ruby variable `RUBIES` is defined in the ERB binding during pipeline file generation. This variable looks like:
+
+``` 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"
+  }
+```
+
+and allows you to write a pipeline like this to get coverage on all the supported rubies:
+
+``` yaml
+# myproject.yaml.erb
+jobs:
+  <% for ruby_version in RUBIES[:mri] %>
+  - name: "ruby-<%= ruby_version %>"
+    plan:
+      - get: git-master
+        trigger: true
+      - task: rake-test
+    ...
+  <% end %>
+```
+
+
+### `fly_target`
+
+Any rake task that needs to interact with your Concourse ATC requires a `fly_target` argument. The value should be a fly target `name`, and it's assumed that you're already logged in to that target.
+
 
 ### Managing your Concourse pipeline
 
@@ -27,7 +63,7 @@ rake concourse:clean                # remove generate pipeline file
 rake concourse:generate             # generate and validate the pipeline file for myproject
 ```
 
-A task to upload your pipeline file to the cloud:
+A task to update your pipeline configuration:
 
 ```
 rake concourse:set[fly_target]      # upload the pipeline file for myproject
@@ -47,49 +83,18 @@ rake concourse:pause[fly_target]    # pause the myproject pipeline
 rake concourse:unpause[fly_target]  # unpause the myproject pipeline
 ```
 
+
 ### Running tasks with `fly execute`
 
 ```
-rake concourse:tasks                                        # list all the available tasks from the nokogiri pipeline
-rake concourse:task[fly_target,task_name,fly_execute_args]  # fly execute the specified task
-```
-
-where `fly_execute_args` will default to use the project name, e.g. `--input=myproject=.`, so your pipeline should name the input resource appropriately.
-
-
-
-### `fly_target`
-
-The `fly_target` argument should be a fly target `name`, and the rake tasks assume that you're logged in already to that target.
-
-
-### Templating and `RUBIES`
-
-The ruby variable `RUBIES` is defined during the context of pipeline generation. The structure is something like:
-
-``` 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"
-  }
+rake concourse:tasks                                       # list all the available tasks from the nokogiri pipeline
+rake concourse:task[fly_target,job_task,fly_execute_args]  # fly execute the specified task
 ```
 
-and allows you to write your pipeline like this to get coverage on all the supported rubies:
+where:
 
-``` yaml
-# myproject.yaml.erb
-jobs:
-  <% for ruby_version in RUBIES[:mri] %>
-  - name: "ruby-<%= ruby_version %>"
-    plan:
-      - get: git-master
-        trigger: true
-      - task: rake-test
-    ...
-  <% end %>
-```
+* _required_: `job_task` is formatted as `job-name/task-name`, for example, `ruby-2.4/rake-test`. Run the `concourse:tasks` rake task to see all available names.
+* _optional_: `fly_execute_args` will default to map the project directory to a resource with the project name, e.g. `--input=myproject=.`, so your pipeline must name the input resource appropriately in order to use the default.
 
 
 ## Installation

data/lib/concourse.rb

@@ -81,21 +81,21 @@ class Concourse
         end
 
         puts "Available Concourse tasks for #{project_name} are:"
-        tasks.each { |task| puts " * #{task}" }
+        tasks.sort.each { |task| puts " * #{task}" }
       end
 
       desc "fly execute the specified task"
-      task "task", [:fly_target, :task_name, :fly_execute_args] => "generate" do |t, args|
+      task "task", [:fly_target, :job_task, :fly_execute_args] => "generate" do |t, args|
         fly_target = Concourse.validate_fly_target t, args
-        task_name        = args[:task_name]
+        job_task = args[:job_task]
         fly_execute_args = args[:fly_execute_args] || "--input=#{project_name}=."
 
-        unless task_name
+        unless job_task
           raise "ERROR: must specify a task name, like `rake #{t.name}[target,taskname]`"
         end
 
-        concourse_task = find_task task_name
-        raise "ERROR: could not find task `#{task_name}`" unless concourse_task
+        concourse_task = find_task job_task
+        raise "ERROR: could not find task `#{job_task}`" unless concourse_task
 
         puts concourse_task.to_yaml
         Tempfile.create do |f|
@@ -117,8 +117,8 @@ class Concourse
     end
   end
 
-  def find_task task_name
-    job_name, task_name = *task_name.split("/")
+  def find_task job_task
+    job_name, task_name = *job_task.split("/")
     each_task do |job, task|
       return task if task["task"] == task_name && job["name"] == job_name
     end

data/lib/concourse/version.rb

@@ -2,5 +2,5 @@ require "rake"
 require "erb"
 
 class Concourse
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: concourse
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Mike Dalessio