ufo 3.5.5 → 3.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f3cffb0c5f3bb15b7f6a236fab1821ec671a0a58f316d05546b0cc2343df31f
-  data.tar.gz: 0cbe0fe89dad15e6501ec136ecf5eb762861b6827939d520616d16d871a7bbaa
+  metadata.gz: 5bd34e1498279908085f391c5496c1aa8081447be4e00df457aa44ad12ad0b3a
+  data.tar.gz: b607ce6631b39b7db8a92f5457bace98ad8efed5df552c3aa7bbf496b351d1a5
 SHA512:
-  metadata.gz: 19ccd9c0ed6f4cb8b2277e5895e3a92effdf47b40ea6424b1f64cc158f73182c402feebdc3fae45234b10b1b92f3b039b85b76ce5047fb61a554b42016a16f73
-  data.tar.gz: 633bc8eba241b343ee35e7927fd2d47bd609b5ca370096de8ab39581cd1608bac757e111a7b1cd02fc44b3b03b818a5848003523e84de57a6b32aab3980424cd
+  metadata.gz: 654a0b5f161aaf4e31c13f3737d3b4aeb1592935235149f222f7019862f6b7d72fb412a8fc5eb8bfd692b06619a0db48b2c647fc4565b986e95f5e9f7818cb4e
+  data.tar.gz: 5d166cd32cc455b49ebc919415d945efde71198b00028509120c95bbe49d2eb79fb7e271148db2ddc9dcc99b9c194f45727eb10fdd12a26637f6ab514fdd937f

data/.gitignore

@@ -9,7 +9,6 @@ doc/
 InstalledFiles
 lib/bundler/man
 pkg
-pkg
 rdoc
 spec/fixtures/hi
 spec/fixtures/home

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 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.5.6]
+- upgrade ufo with cli-template, link cli help to website reference help
+
 ## [3.5.5]
 - Merge pull request #39 from hnatt/fix-docs
 - Merge pull request #41 from tongueroo/params-template-scope

data/Rakefile

@@ -1,7 +1,7 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-task :default => :spec
+task default: :spec
 
 RSpec::Core::RakeTask.new
 

data/docs/_docs/faq.md

@@ -4,12 +4,12 @@ title: FAQ
 
 **Q: Is AWS ECS Fargate supported?**
 
-Yes, Fargate is supported.  To use ufo with Fargate, you will need to adjust the template in `.ufo/templates` to use a structure support by Fargate.  There are 2 key items to adjust:
+Yes, Fargate is supported.  To use ufo with Fargate, you will need to adjust the template in `.ufo/templates` to a structure supported by Fargate.  There are 2 key items to adjust:
 
-1. The task definition json. Notably, it has the `requiresCompatibilities`, `networkMode`, and `executionRoleArn` attributes. It also moves the `cpu` and `memory` outside of the `containerDefinitions` attributes to the root as top-level attributes. For details on how to adjust the task definition refer to [Task Definitions]({% link _docs/tutorial-ufo-tasks-build.md %}).
-2. The params that get sent to the `create_service` or  `run_task` api methods. For details on how to adjust the params refer to [Params]({% link _docs/params.md %})
+1. The task definition JSON. Notably, the JSON structure has the `requiresCompatibilities`, `networkMode`, and `executionRoleArn` attributes. The `cpu` and `memory` attributes also move outside of the `containerDefinitions` level to the top-level attributes. For details on how to adjust the task definition refer to [Task Definitions]({% link _docs/tutorial-ufo-tasks-build.md %}).
+2. The params that get sent to the `create_service` or  `run_task` API methods. For details on how to adjust the params refer to [Params]({% link _docs/params.md %})
 
-If it's a brand new project, you can use `ufo init` with the `--launch-type fargate` option and it will generate a starter JSON file that has the right Fargate structure. More info is available at [ufo init reference](/reference/ufo-init/#fargate-support).
+If it's a brand new project, you can use `ufo init` with the `--launch-type fargate` option and it will generate a starter task definition JSON file that has the right Fargate structure. More info is available at [ufo init reference](/reference/ufo-init/#fargate-support).
 
 **Q: Can I tell ufo to use specific docker build options?**
 

data/docs/_docs/structure.md

@@ -7,6 +7,7 @@ Ufo creates a `.ufo` folder within your project which contains the required file
 ```sh
 .ufo
 ├── output
+├── params.yml
 ├── settings.yml
 ├── task_definitions.rb
 ├── templates
@@ -22,6 +23,7 @@ The table below covers the purpose of each folder and file.
 File / Directory  | Description
 ------------- | -------------
 <code>output/</code>  | The folder where the generated task definitions are written to.  The way the task definitions are generated is covered in [ufo tasks build]({% link _docs/tutorial-ufo-tasks-build.md %}).
+<code>params</code>  | This is where you can adjust the params that get send to the aws-sdk api calls. More info at [Params]({% link _docs/params.md %}).
 <code>settings.yml</code>  | Ufo's settings file, where you adjust the default [settings]({% link _docs/settings.md %}).
 <code>task_definitions.rb</code>  | This is where you define the task definitions and specify the variables to be used by the ERB templates.
 <code>templates/</code>  | The ERB templates with the task definition json code.  The templates are covered in more detail in [ufo tasks build]({% link _docs/tutorial-ufo-tasks-build.md %}).

data/docs/_docs/tutorial-ufo-tasks-build.md

@@ -4,14 +4,14 @@ title: Task Definitions
 
 ## Build the ECS Task Definitions
 
-Now that we have a docker image pushed to a registry we can use that image for ECS.  Ufo takes that image and adds it to an ECS task definition.  This is where ufo is super powerful.  Ufo gives you the power to build and control your ECS task definition easily.
+Now that we have a docker image pushed to a registry we can use that image for ECS.  Ufo takes that image and adds it to an ECS task definition.  This is where ufo is powerful.  Ufo gives you the power to build and control your ECS task definition directly.
 
 Let's take a look at the 2 files that are used by ufo to build the ECS task definition.  These files were generated by the `ufo init` command at the beginning.
 
 1. `.ufo/templates/main.json.erb`
 2. `.ufo/task_definitions.rb`
 
-Ufo task definitions are written as an ERB template that makes it every easily accessible and configurable to your requirements.  Here is is an example of an ERB template `.ufo/templates/main.json.erb` that shows how easy it is to modfied the task definition you want to be uploaded by ufo:
+Ufo task definitions are written as an ERB template that makes it directly accessible. You can configure to your requirements.  Here is an example of an ERB template `.ufo/templates/main.json.erb` that shows how to modify the task definition you want ufo to upload:
 
 **.ufo/templates/main.json.erb**:
 
@@ -61,7 +61,7 @@ end
 
 ## Shared Variables
 
-Ufo has a concept of shared variables, covered in [Shared Variables]({% link _docs/variables.md %}). The shared variables are set in the `variables` folder and essentially allow you to use a set of shared variables through your templates:
+Ufo has a concept of shared variables, covered in [Shared Variables]({% link _docs/variables.md %}). The shared variables are set in the `variables` folder and essentially allow you to use a set of shared variables throughout your templates:
 
 **.ufo/variables/base.rb**:
 
@@ -83,7 +83,7 @@ Ufo has a concept of shared variables, covered in [Shared Variables]({% link _do
 
 Ufo combines the `main.json.erb` template, `task_definitions.rb` definitions, and variables in the `.ufo/variables` folder.  It then generates the raw AWS formatted task definition in the `output` folder.
 
-If you need to modify the task definition template to suite your own needs it is super simple, just edit `main.json.erb`.  You do not have to dive deep into internal code somewhere.  It is all there for you to fully control.
+If you need to modify the task definition template to suit your own needs it is simple, just edit `main.json.erb`.  You do not have to dive deep into internal code somewhere.  It is all there for you to control fully.
 
 The `task_definition.rb` has access to some useful helper methods detailed in [Helpers]({% link _docs/helpers.md %}).
 
@@ -156,7 +156,7 @@ You have built the ECS task definitions locally on your machine. To register the
 ufo tasks register
 ```
 
-You should see something similiar to this:
+You should see something similar to this:
 
 ```sh
 hi-clock task definition registered.
@@ -167,4 +167,3 @@ hi-worker task definition registered.
 <a id="prev" class="btn btn-basic" href="{% link _docs/tutorial-ufo-docker-build.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/tutorial-ufo-ship.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-

data/lib/ufo/command.rb

@@ -42,6 +42,41 @@ module Ufo
 
         super
       end
+
+      # Override command_help to include the description at the top of the
+      # long_description.
+      def command_help(shell, command_name)
+        meth = normalize_command_name(command_name)
+        command = all_commands[meth]
+        alter_command_description(command)
+        super
+      end
+
+      def alter_command_description(command)
+        return unless command
+
+        # Add description to beginning of long_description
+        long_desc = if command.long_description
+            "#{command.description}\n\n#{command.long_description}"
+          else
+            command.description
+          end
+
+        # add reference url to end of the long_description
+        unless website.empty?
+          full_command = [command.ancestor_name, command.name].compact.join('-')
+          url = "#{website}/reference/ufo-#{full_command}"
+          long_desc += "\n\nHelp also available at: #{url}"
+        end
+
+        command.long_description = long_desc
+      end
+      private :alter_command_description
+
+      # meant to be overriden
+      def website
+        "http://ufoships.com"
+      end
     end
   end
 end

data/lib/ufo/help/completion_script.md

@@ -1,3 +1,3 @@
-To use, add the following to your ~/.bashrc or ~/.profile
+To use, add the following to your `~/.bashrc` or `~/.profile`
 
-  eval $(ufo completion_script)
+    eval $(ufo completion_script)

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "3.5.5"
+  VERSION = "3.5.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 3.5.5
+  version: 3.5.6
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatchlogs
@@ -421,7 +421,6 @@ files:
 - lib/ufo/help/docker/clean.md
 - lib/ufo/help/docker/name.md
 - lib/ufo/help/docker/push.md
-- lib/ufo/help/hello.md
 - lib/ufo/help/init.md
 - lib/ufo/help/scale.md
 - lib/ufo/help/ship.md
@@ -484,7 +483,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Build Docker Containers and Ship Them to AWS ECS

data/lib/ufo/help/hello.md

@@ -1,5 +0,0 @@
-## Examples
-
-  ufo hello
-  ufo hello NAME
-  ufo hello NAME --from me