README.md in humidifier-4.0.2 vs README.md in humidifier-4.1.1
- old
+ new
@@ -1,9 +1,9 @@
# Humidifier
-[](https://travis-ci.com/kddeisz/humidifier)
-[](https://rubygems.org/gems/humidifier)
+[](https://github.com/kddnewton/humidifier/actions)
+[](https://rubygems.org/gems/humidifier)
Humidifier is a ruby tool for managing [AWS CloudFormation](https://aws.amazon.com/cloudformation/) stacks. You can use it to build and manage stacks programmatically or you can use it as a command line tool to manage stacks through configuration files.
- [Installation](#installation)
- [Getting started](#getting-started)
@@ -20,10 +20,11 @@
- [Using the CLI](#using-the-cli)
- [`change [?stack]`](#change-stack)
- [`deploy [?stack] [*parameters]`](#deploy-stack-parameters)
- [`display [stack] [?pattern]`](#display-stack-pattern)
- [`stacks`](#stacks)
+ - [`upgrade`](#upgrade)
- [`upload [?stack]`](#upload-stack)
- [`validate [?stack]`](#validate-stack)
- [Parameters](#parameters)
- [Shortcuts](#shortcuts)
- [Automatic id properties](#automatic-id-properties)
@@ -188,11 +189,11 @@
groups:
- Management
- Administration
```
-The top-level keys are the logical resource names that will be displayed in the CloudFormation screen. They point to a map of key/value pairs that will be passed on to `humidifier`. Any `humidifier` (and therefore any CloudFormation) attribute may be specified. For more information on CloudFormation templates and which attributes may be specified, see both the [`humidifier` docs](http://kddeisz.github.io/humidifier) and the [CloudFormation docs](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html).
+The top-level keys are the logical resource names that will be displayed in the CloudFormation screen. They point to a map of key/value pairs that will be passed on to `humidifier`. Any `humidifier` (and therefore any CloudFormation) attribute may be specified. For more information on CloudFormation templates and which attributes may be specified, see both the [`humidifier` docs](http://kddnewton.github.io/humidifier) and the [CloudFormation docs](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html).
### Mappers
Oftentimes, specifying these attributes can become repetitive, e.g., each user should automatically receive the same "path" attribute. Other times, you may want custom logic to execute depending on which AWS environment you're running in. Finally, you may want to reference resources in the same or other stacks.
@@ -257,10 +258,14 @@
#### `stacks`
Displays the names of all of the stacks that `humidifier` is managing.
+#### `upgrade`
+
+Downloads the latest CloudFormation resource specification. Periodically AWS will update the file that `humidifier` is based on, in which case the attributes of the resources that were changed could change. This gem usually stays relatively in sync, but if you need to use the latest specs and this gem has not yet released a new version containing them, then you can run this command to download the latest specs onto your system.
+
#### `upload [?stack]`
Upload one or all stacks in the repo to S3 for reference later. Note that this must be combined with the `humidifier` `s3_bucket` configuration option.
#### `validate [?stack]`
@@ -395,10 +400,10 @@
The specs pulled from the CFN docs is saved to `CloudFormationResourceSpecification.json`. You can update it by running `bundle exec rake specs`. This script will pull down the latest [resource specification](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-resource-specification.html) to be used with Humidifier.
### Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/kddeisz/humidifier.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kddnewton/humidifier.
### License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).