ufo 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd2207a0617cee46aeb0459643f5fcd3fa2605ea7e0052020bd310e987dc38b
-  data.tar.gz: f3bf371e109599f6ea57418abbd3b87dba06400144c97028af46d32ad7a2fd0c
+  metadata.gz: f2b8040ac25daf8bb18e20492774df63394ebde64beaa05146146c12565f32c4
+  data.tar.gz: b9466b234f2c5d6a6b9cc4e838247546757e94ef8b4e11f1164e7517bf83147c
 SHA512:
-  metadata.gz: 0d391674506d0f5b68cd4e403a6a6d14141c52069244f991a4b280e69d013c0d7ce6be8a8a66b6a05bedb4600d2b28b171ec9aab6820113e2c00aaf1208368d5
-  data.tar.gz: 3c857cfabc2c40297f40271c75fc728fe4a556f35534b4b9451b650c81d7216b6e6bf87ac1861e210322e06c4a179e0114fbde4ef158a120838033a5254c6a0d
+  metadata.gz: 6802b517797d2a056cb08d9c3ca07e1840caf281bcbfe12c103f1c1485b226e7da4c9cc6e804beb6581e37667e45152b76978a895c3cc8d4ab9c4bfd5a151544
+  data.tar.gz: 1ce8caef75586ed9cb21434bdc225605ef92418a1e643282e99ecdcba46d9817f153edd3d323978f4414bafbb71895146504601eef86d2670f257277f86e66ac

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [3.2.2]
+- add .ufo/data to gitignore for upgrade3
+- allow system exit to normally happen for rendering error in the task definition
+- docs grammar fixes
+
 ## [3.2.1]
 - ensure settings is always a hash even when settings.yml has nil
 - move cli_markdown as development dependency

data/docs/_docs/auto-completion.md

@@ -2,13 +2,13 @@
 title: Auto Completion
 ---
 
-Ufo supports bash auto-completion.  To set it up add this to your `~/.profile` or `.bashrc`:
+Ufo supports bash auto-completion.  To set it up add the following to your `~/.profile` or `.bashrc`:
 
 ```
 eval $(ufo completion_script)
 ```
 
-Don't forget to restart your shell.
+Remember to restart your shell or source your profile file.
 
 Auto Completion examples:
 

data/docs/_docs/automated-cleanup.md

@@ -2,7 +2,7 @@
 title: Automated Clean Up
 ---
 
-Ufo can be configured to automatically clean old images from the ECR registry after the deploy completes by configuring the your [settings.yml]({% link _docs/settings.md %}) file like so:
+Ufo can be configured to automatically clean old images from the ECR registry after the deploy completes by configuring your [settings.yml]({% link _docs/settings.md %}) file like so:
 
 ```yaml
 ecr_keep: 30

data/docs/_docs/conventions.md

@@ -2,21 +2,21 @@
 title: Conventions
 ---
 
-Ufo uses a set of naming conventions.  This helps enforce some best practices and also allows the ufo commands to be concise.  Ufo allows you to easily override or bypass the conventions if you need it.
+Ufo uses a set of naming conventions.  This helps enforce some best practices and also allows the ufo commands to be concise.  You can override or bypass the conventions easily.
 
 ## UFO_ENV to ECS Cluster Convention
 
-By default, the ECS cluster value is the same as UFO_ENV's value.  So if `UFO_ENV=production` then the ECS Cluster is `production` and if `UFO_ENV=development` then the ECS Cluster is `development`.  You can easily override this convention by specifying the `--cluster` CLI option.  You can also override this behavior with [settings.yml]({% link _docs/settings.md %}) to spare you from having to type `--cluster` over and over.
+By default, the ECS cluster value is the same as UFO_ENV's value.  So if `UFO_ENV=production` then the ECS Cluster is `production` and if `UFO_ENV=development` then the ECS Cluster is `development`.  You can override this convention by specifying the `--cluster` CLI option.  You can also override this behavior with [settings.yml]({% link _docs/settings.md %}) to spare you from having to type `--cluster` repeatedly.
 
 ## Service and Task Names Convention
 
-Ufo assumes a convention that service\_name and the task\_name are the same. If you would like to override this convention then you can specify the task name.
+Ufo assumes a convention that service\_name and the task\_name are the same. If you would like to override this convention, then you can specify the task name.
 
 ```
 ufo ship hi-web --task my-task
 ```
 
-This means that in the task_definition.rb you will also defined it with `my-task`.  For example:
+This means that in the task_definition.rb you will also define it with `my-task`.  For example:
 
 ```ruby
 task_definition "my-task" do

data/docs/_docs/helpers.md

@@ -4,14 +4,14 @@ title: Helpers
 
 The `task_definitions.rb` file has access to helper methods. These helper methods provide useful contextual information about the project.
 
-For example, one of the helper methods provides the exposed port in the Dockerfile of the project. This is useful if someone changes the exported port in the Dockerfile, he likely to forget to also update the ufo variable so it is referenced via the helper. Here is a list of the helpers:
+For example, one of the helper methods provides the exposed port in the Dockerfile of the project. This is useful if someone changes the exported port in the Dockerfile, he will likely forget to also update the ufo variable.  You can reference the port via the helper to prevent this from happening. Here is a list of the helpers:
 
 Helper  | Description
 ------------- | -------------
 full\_image\_name | The full docker image name that ufo builds. The "base" portion of the docker image name is defined in `settings.yml`. For example, the base portion is `tongueroo/hi` and the full image name is `tongueroo/hi:ufo-[timestamp]-[sha]`. The base name does not include the generated Docker tag, which contains a timestamp and git sha of the Dockerfile that is used.
 dockerfile\_port | Exposed port extracted from the Dockerfile of the project. 
 env_vars(text) | This method takes a block of text that contains the env values in `key=value` format and converts that block of text to the proper task definition json format.
-env_file(path) | This method takes an `.env` file which contains a simple key value list of environment variables and converts the list to the proper task definition json format.
+env_file(path) | This method takes a `.env` file which contains a simple key-value list of environment variables and converts the list to the proper task definition JSON format.
 task_definition_name | The name of the task_definition.  So if the code looks like this `task_definition "demo-web" do`, the task_definition_name is "demo-web".
 
 To call the helper in task_definitions.rb you must add `helper.` in front.  So `full_image_name` is called via `helper.full_image_name`.

data/docs/_docs/install.md

@@ -18,7 +18,7 @@ gem "ufo"
 
 ## Install with Bolts Toolbelt
 
-If you want to quickly install ufo without having to worry about ufo's dependencies you can simply install the Bolts Toolbelt which has ufo included.
+If you want to quickly install ufo without having to worry about ufo's dependencies you can install the Bolts Toolbelt which has ufo included.
 
 ```sh
 brew cask install boltopslabs/software/bolts

data/docs/_docs/migrations.md

@@ -2,7 +2,7 @@
 title: Database Migrations
 ---
 
-A common task is to run database migrations with newer code before deploying the actual code. This is easily achieved with the `ufo task` command. Here's an example:
+A common task is to run database migrations with newer code before deploying the code. This is easily achieved with the `ufo task` command. Here's an example:
 
 ```sh
 ufo task hi-web --command bundle exec rake db:migrate
@@ -21,11 +21,11 @@ The `bin/migrate` script can look like this:
 bundle exec rake db:migrate
 ```
 
-The `ufo task` command is generalized so you can actually run any one-off task. It is not just limited to running migrations. The `ufo task` command performs the following:
+The `ufo task` command is generalized so you can run any one-off task. It is not just limited to running migrations. The `ufo task` command performs the following:
 
 1. Builds the docker image and pushes it to a registry
 2. Registers the ECS Task definition
-3. Runs an one-off ECS Task
+3. Runs a one-off ECS Task
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/single-task.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/automated-cleanup.md %}">Next Step</a>

data/docs/_docs/ufo-env.md

@@ -49,7 +49,7 @@ AWS_PROFILE=my-dev-profile => UFO_ENV=development
 AWS_PROFILE=whatever => UFO_ENV=development # since there are no profiles that match
 ```
 
-Notice how `AWS_PROFILE=whatever` results in `UFO_ENV=development`.  This is because there are not matching aws_profiles in the `settings.yml`.  More info on settings is available at [settings]({% link _docs/settings.md %}).
+Notice how `AWS_PROFILE=whatever` results in `UFO_ENV=development`.  This is because there are no matching aws_profiles in the `settings.yml`.  More info on settings is available at [settings]({% link _docs/settings.md %}).
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/settings.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/variables.md %}">Next Step</a>

data/docs/_docs/variables.md

@@ -28,7 +28,7 @@ Shared variables also support a concept called layering.  The `variables/base.rb
 @environment = helper.env_file(".env")
 ```
 
-When `ufo ship` is ran with `UFO_ENV=production` he `variables/production.rb` will be evaluated and layered on top of the variables defined in `base.rb:
+When `ufo ship` is ran with `UFO_ENV=production` he `variables/production.rb` will be evaluated and layered on top of the variables defined in `base.rb`:
 
 `.ufo/variables/production.rb`:
 
@@ -39,7 +39,7 @@ When `ufo ship` is ran with `UFO_ENV=production` he `variables/production.rb` wi
 ])
 ```
 
-When `ufo ship` is ran with `UFO_ENV=development` the `variables/development.rb` will be evaluated and layered on top of the variables defined in `base.rb:
+When `ufo ship` is ran with `UFO_ENV=development` the `variables/development.rb` will be evaluated and layered on top of the variables defined in `base.rb`:
 
 
 `.ufo/variables/development.rb`:

data/lib/ufo/dsl.rb

@@ -27,9 +27,13 @@ module Ufo
       begin
         instance_eval(source_code, @template_definitions_path)
       rescue Exception => e
-        task_definition_error(e)
-        puts "\nFull error:"
-        raise
+        if e.class == SystemExit # allow exit to happen normally
+          raise
+        else
+          task_definition_error(e)
+          puts "\nFull error:"
+          raise
+        end
       end
     end
 

data/lib/ufo/setting.rb

@@ -39,17 +39,17 @@ module Ufo
       data = YAML.load(content)
       # If key is is accidentally set to nil it screws up the merge_base later.
       # So ensure that all keys with nil value are set to {}
-      data.each do |ufo_env, _setting|
-        data[ufo_env] ||= {}
+      data.each do |env, _setting|
+        data[env] ||= {}
       end
       data
     end
 
     # automatically add base settings to the rest of the environments
     def merge_base(all_envs)
-      base = all_envs["base"]
-      all_envs.each do |ufo_env, env_settings|
-        all_envs[ufo_env] = base.merge(env_settings) unless ufo_env == "base"
+      base = all_envs["base"] || {}
+      all_envs.each do |env, settings|
+        all_envs[env] = base.merge(settings) unless env == "base"
       end
       all_envs
     end

data/lib/ufo/upgrade3.rb

@@ -35,9 +35,11 @@ module Ufo
 
     def upgrade_gitignore
       lines = IO.readlines(".gitignore")
-      text = lines.map do |line|
-          line.sub(/[\/]?ufo/, '.ufo')
-        end.join
+      lines.map! do |line|
+        line.sub(/[\/]?ufo/, '.ufo')
+      end
+      lines << [".ufo/data\n"] # new ignore rule
+      text = lines.join
       IO.write(".gitignore", text)
     end
 

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "3.2.1"
+  VERSION = "3.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatchlogs