gz_release 0.0.9 → 0.0.12

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTgwYTBlMjZkY2ZkZTg0YTZjMzZlOTc5OTRjNzQ5MjY1YmVmNTg3ZA==
-  data.tar.gz: !binary |-
-    ZTUwYTYwOGIzZTZlNDFkYzAzN2UzZGRmODBlMmE2ZmY0YzU4ZmFmNg==
+SHA1:
+  metadata.gz: 9bbc82adef3d8c1c27ab5a9be6929da282f5b597
+  data.tar.gz: da8f59523e55deaa777a9c63193f69d66ca18539
 SHA512:
-  metadata.gz: !binary |-
-    MWQ0YzVjMGFlNWY5ZTkxODcyNjU5YjIzMzc5YmIwODJkZWY0MTE0NGZlNDE5
-    YjAzYWJjNDg1NTQ5OTUzZDZkNmRkNzk3MDQ0YjI4ZTM4OTc0NmUwMDliYjVj
-    MDcwOTUyOGJkMDAwYjVlZmExNzI1NTdmZTFjOWMxNDViNDg0NzM=
-  data.tar.gz: !binary |-
-    MDEyY2M2YWM2OWNmODIzYjlhZmQ2MmM4YTU4NzA0NGZiOTQxNmM1NmMxMDdi
-    NGNhMzNlZWNmNTM1NzFhODIyNjg2NTcwNzk0NGFjYjlmMjM3M2VkNDEzODRm
-    Y2Y3ZDVlZTY5MWRiMTdkZDY0M2Q1MmRhN2E1MDY1YTQ3MTk1NjE=
+  metadata.gz: 8579026090136e2a4f7423615f8659c527fd0039ecf6f5a2443ab346676d3e3833a46edd301aa61fcfed997b620261f739feb40c903a443fb23fc6d6cd866449
+  data.tar.gz: a680fc1e62e1627d1bfb55fa6f136754203eeef89e63d2d8a5e5b2ea08a2f2e488b5ebf9c64b0aaae4a19c830881dfbc690cd1f1d11cf2d3114824dca7d3943f

data/README.md

@@ -20,7 +20,73 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Rakefile
+
+Add the following to your `Rakefile`:
+
+``` ruby
+require 'gz_release'
+
+GzRelease::Tasks.install(
+  image_name: 'gazelle/<PROJECT_NAME>'
+)
+```
+
+This gives you a bunch of rake tasks:
+
+```
+rake release:build           # Builds the docker image from generated Dockerfile
+rake release:dump            # Dumps docker cache into ~/.docker/image.tar
+rake release:load            # Loads ~/.docker/image.tar into docker cache
+rake release:pull            # Pulls latest version of the image from dockerhub
+rake release:push:branch     # Pushes docker image tagged as current git branch
+rake release:push:latest     # Pushes docker image tagged as latest
+rake release:push:release    # Pushes docker image tagged as release
+rake release:push:timestamp  # Pushes docker image and git tag tagged by the timestamp
+rake release:push:version    # Pushes docker image tagged as version specified in Rakefile
+rake release:tag:branch      # Creates a tag for the branch for the docker image
+rake release:tag:latest      # Creates latest tag for the docker image
+rake release:tag:release     # Creates release tag for the docker image
+rake release:tag:timestamp   # Creates timestamp tag for the docker image and git repo
+rake release:tag:version     # Creates a tag for version specified in Rakefile for docker image
+```
+
+### Environment variables
+
+The following evironment variables are required for pushing to a docker repository: `DOCKER_USER`, `DOCKER_EMAIL`, `DOCKER_PASSWORD`. They are the same values you provide when doing `docker login`. It's best to use an organization account for these values on CircleCI.
+
+Optionally, you can also set `DOCKER_REPOSITORY` (e.g. tutum.co), which will cause the image to be tagged for and pushed to that repository.
+
+### Building on CircleCI
+
+Create the environment variables for your project listed above on CircleCI. You can then have CircleCI build the docker image by creating a `circle.yml` including the following:
+
+``` yaml
+machine:
+  services:
+    - docker
+checkout:
+  pre:
+    - git config --global user.email "circleci@gazelle.com"
+    - git config --global user.name "Gazelle CircleCI Bot"
+deployment:
+  all:
+    branch: /^(?!(master|dev)).*$/
+    commands:
+      - bundle exec rake release:build
+      - bundle exec rake release:push:branch
+  master:
+    branch: master
+    commands:
+      - bundle exec rake release:build
+      - bundle exec rake release:push:timestamp
+      - bundle exec rake release:push:release
+  dev:
+    branch: dev
+    commands:
+      - bundle exec rake release:build
+      - bundle exec rake release:push:latest
+```
 
 ## Contributing
 

data/lib/gz_release.rb

@@ -1,4 +1 @@
-require 'English'
 require 'gz_release/version'
-require 'gz_release/tasks'
-require 'gz_release/test_helper'

data/lib/gz_release/tasks.rb

@@ -1,7 +1,10 @@
+require 'English'
+require 'rake'
+
 module GzRelease
   # Rake tasks for building a docker image
   class Tasks
-    include Rake::DSL if defined? Rake::DSL
+    include Rake::DSL
 
     DOCKERFILE_PATH = File.expand_path('./Dockerfile')
     DOCKER_CACHE_PATH = File.expand_path('~/.docker')
@@ -176,7 +179,7 @@ module GzRelease
     end
 
     def branch
-      @branch ||= ENV['CIRCLE_BRANCH'] ? ENV['CIRCLE_BRANCH'] : `git rev-parse --abbrev-ref HEAD`.strip
+      @branch ||= (ENV['CIRCLE_BRANCH'] ? ENV['CIRCLE_BRANCH'] : `git rev-parse --abbrev-ref HEAD`).strip.gsub(/\//,'_')
     end
 
     # Version

data/lib/gz_release/version.rb

@@ -1,4 +1,4 @@
 # Version
 module GzRelease
-  VERSION = '0.0.9'
+  VERSION = '0.0.12'
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: gz_release
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.12
 platform: ruby
 authors:
 - Allen Madsen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Tasks for building docker images on a CI
@@ -45,8 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
+- ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -66,19 +66,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Tasks for building docker images on a CI
 test_files: []
-has_rdoc: