rumrunner 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d418721530bb2d83cf3fe7234869b48c959b1971aa0ca6be441378ae286221cb
-  data.tar.gz: 6b2344351417b923e61a1e8e0be5def1d57dffa626d226a87041d6395f385230
+  metadata.gz: 3f5c7dac4315813fa3843d94e075608585d4e6cdd9c1b52f6c447b8981ada492
+  data.tar.gz: 778ac8a9026a12e33edee3af59ea0e3d66b363d7eeee8ee88c4c777e98ffee86
 SHA512:
-  metadata.gz: 3a252b63a40a3604cb7379ba019e8ffef53ea0d8aa2882eb632501cb83a99ada8c0d794a9e5a01bf0e698bb4b107922329cd93a3a3bb64deba287f134d671d37
-  data.tar.gz: bc1a516772e49aba48f2b5e05d967fc3c6b494a3fb4ab655dfe976652bdf2c1c3f6e4470f24a9ba3843b1038c7d97166d8efc7823cdaeb25b69177240d9a8288
+  metadata.gz: ef19b7605a22e532753f2c6eefa7fdeadd51584a6804dea22b57cedf36e38441e0125c34756e7445952d3bce5aff2764232aa0a13d305b148335fb2787424f96
+  data.tar.gz: a48ff0e320ea4b6c5a7521d734da3b4871ce0fb9822ae7fc6deb36a80e8c7b3c44863a1e76ee30d243c144f5d9c87431f0a5ef017bc74d0ea71f6a39bda1fffd

data/README.md

@@ -5,11 +5,9 @@
 
 Rum Runner is a Rake-based utility for building multi-stage Dockerfiles.
 
-Users can pair a multi-stage Dockerfile with a Rumfile that uses a
-Rake-like DSL to customize each stage's build options and dependencies.
+Users can pair a multi-stage Dockerfile with a Rumfile that uses a Rake-like DSL to customize each stage's build options and dependencies.
 
-The `rum` executable allows users to easily invoke builds, shell-into
-specific stages for debugging, and export artifacts from built containers.
+The `rum` executable allows users to easily invoke builds, shell-into specific stages for debugging, and export artifacts from built containers.
 
 Rum Runner has the following features:
 * Rake-like DSL/CLI that enable simple annotation and execution of builds.
@@ -19,12 +17,34 @@ Rum Runner has the following features:
 * Shell tasks are automatically provided for every stage
 * Stage, artifact, and shell, steps can be customized
 
+**Origins**
+
+This project was born from using Makefiles to drive multi-stage builds. For the most part this worked really well, but it became a bit of an ordeal to write for more complex projects. This tool is an attempt to recreate that general technique with minimal annotation and limited assumptions.
+
 ## Installation
 
 ```bash
 gem install rumrunner
 ```
 
+## Quickstart
+
+Use the helper `Rum.init` to create a template Rumfile for your project:
+
+```bash
+# Install the gem
+gem install rumrunner
+
+# Navigate to the location of your Dockerfile
+cd /path/to/your/Dockerfile/project/
+
+# Create a basic Rumfile
+ruby -r rumrunner -e Rum.init > Rumfile
+
+# View available tasks
+rum --tasks
+```
+
 ## Example
 
 Imagine a simple multi-stage Dockerfile:
@@ -46,9 +66,9 @@ Create `Rumfile` and describe your build:
 rum :image_name do
   tag "1.2.3"
 
-  stage :build
-  stage :test => :build
-  stage :deploy => :test
+  stage :build           # => docker build --target build  --tag image_name:1.2.3-build .
+  stage :test => :build  # => docker build --target test   --tag image_name:1.2.3-test .
+  stage :deploy => :test # => docker build --target deploy --tag image_name:1.2.3-deploy .
 end
 ```
 
@@ -88,6 +108,41 @@ rum :image_name => "tmp" do |c|
 end
 ```
 
+## Build vs. Run
+
+At the core, every directive within the `rum` block will eventually be interpreted as either a `docker build` or a `docker run` command. The type of directive is simply a way of specifying defaults for the command.
+
+If you simply wish to define a named task that executes a build or a run, you can use the `build` or `run` directives:
+
+```ruby
+rum :image_name do
+  build :fizz do
+    tag  "image_name"
+    path "."
+  end # => docker build --tag image_name .
+
+  run :buzz do
+    rm    true
+    image "image_name"
+    cmd   %w{echo hello}
+  end # => docker run --rm image_name echo hello
+end
+```
+
+## Shared ENV variables
+
+The `env` method can be invoked in the `rum` block to declare a value that will be passed to all stages/artifacts/shells. For stages, the value will be passed using the `--build-arg` option; for artifacts and shells, the `--env` option.
+
+```ruby
+rum :image_name do
+  env :FIZZ => :BUZZ
+
+  stage :build # => docker build --build-arg FIZZ=BUZZ ...
+
+  artifact "pkg.zip" => :build # => docker run --env FIZZ=BUZZ ...
+end
+```
+
 ## Customize Stages
 
 Stages can be customized with blocks. Methods invoked on the stage are (with a few exceptions) passed onto the `docker build` command.

data/lib/rumrunner/init.rb

@@ -0,0 +1,19 @@
+require "rumrunner/docker"
+
+module Rum
+  class << self
+    def init
+      # Get image name from stdin
+      $stderr.write "Docker image name: "
+      image = Docker::Image.parse(gets.chomp)
+
+      puts "#!/usr/bin/env ruby"
+      puts "rum :\"#{image.family}\" do"
+      File.read("Dockerfile").scan(/^FROM .*?$/).each_with_index do |line, i|
+        stage = line.scan(/ AS (.*?)$/).flatten.first || i.to_s
+        puts "  stage :\"#{stage}\""
+      end if File.exists? "Dockerfile"
+      puts "end"
+    end
+  end
+end

data/lib/rumrunner/manifest.rb

@@ -35,7 +35,7 @@ module Rum
     def run(*args, &block)
       name, _, deps = Rake.application.resolve_args(args)
       task name => deps do
-        sh Docker::Run.new(&block).to_s
+        sh Docker::Run.new(image: @image, &block).to_s
       end
     end
 
@@ -145,6 +145,8 @@ module Rum
 
     def install
       install_clean
+
+      self
     end
 
     private

data/lib/rumrunner/version.rb

@@ -1,3 +1,3 @@
 module Rum
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/rumrunner.rb

@@ -3,6 +3,7 @@ require "rumrunner/docker"
 require "rumrunner/manifest"
 require "rumrunner/dsl_definition"
 require "rumrunner/application"
+require "rumrunner/init"
 
 module Rum
   class Error < StandardError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumrunner
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alexander Mancevice
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-21 00:00:00.000000000 Z
+date: 2019-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -138,6 +138,7 @@ files:
 - lib/rumrunner/application.rb
 - lib/rumrunner/docker.rb
 - lib/rumrunner/dsl_definition.rb
+- lib/rumrunner/init.rb
 - lib/rumrunner/manifest.rb
 - lib/rumrunner/version.rb
 homepage: https://github.com/amancevice/rumrunner.git