README.md in terragov-0.2.1 vs README.md in terragov-0.2.2
- old
+ new
@@ -1,9 +1,11 @@
# Terragov
-
+[](https://travis-ci.org/surminus/terragov) [](https://badge.fury.io/rb/terragov) [](https://coveralls.io/github/surminus/terragov?branch=master)
+
+
GOV.UK use [Terraform](https://terraform.io) to deploy infrastructure. Originally a lightweight bash script was built to support our opinionated Terraform project structure, but it quickly added further functionality and I decided it would be nicer to use a tool written in a more complete language.
## Installation
`gem install terragov`
@@ -16,11 +18,11 @@
`terragov [CMD] [OPTIONS]`
Run `--help` for details.
-There are several arguments to pass when running `apply`, `plan` or `destroy`:
+There are several **required** arguments to pass when running `apply`, `plan` or `destroy`:
Argument | Description
--- | ---
`stack` | Name of the stack you're deploying to
`environment` | Which environment to deploy to
@@ -36,11 +38,11 @@
Use command line flags to pass the relevant argument. This has **highest** precedence.
### Environment variables
-Every command has an environment variable which can also be set. This has second **highest** precedence. The value is the name, in upper case, and prefixed with `TERRAGOV`. For example, to set `environment`:
+Every command has an environment variable which can also be set. This has **second highest** precedence. The value is the name, in upper case, and prefixed with `TERRAGOV`. For example, to set `environment`:
`export TERRAGOV_ENVIRONMENT=integration`
### Configuration file
@@ -55,9 +57,19 @@
environment: 'integration'
stack: 'blue'
repo_dir: '~/govuk/govuk-aws'
data_dir: '~/govuk/govuk-aws-data/data'
```
+
+## Optional global arguments
+
+These may be set in the same way as described above, with the same precedence, but they are not required.
+
+Argument | Description
+--- | ---
+`verbose` | Be more noisy
+`dryrun` | CLI option is `--dry-run`, but config file and env var is `dryrun` and `TERRAGOV_DRYRUN` respectively
+`skip_git_check` | Do not compare branches between the repo and data directories
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.