From ecf1532f620acf2c8f6aca0878cc6d67cd69a78a Mon Sep 17 00:00:00 2001 From: Emre Erkunt Date: Tue, 10 Jul 2018 14:44:13 +0100 Subject: [PATCH] Changed README. --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9e66aa1d..58d4c0cf 100644 --- a/README.md +++ b/README.md @@ -14,18 +14,25 @@ Code Stability + + + + + - + Downloads @@ -49,7 +56,7 @@ ![Example Run](terraform-compliance-demo.gif) ```sh [~] $ terraform-compliance -f example/example_01 -t example/tf_files -terraform-compliance v0.1.0 initiated +terraform-compliance v0.1.1 initiated Features : /Users/sharky/Repository/terraform-compliance/example/example_01 Steps : /Users/sharky/Repository/venv2/lib/python2.7/site-packages/terraform_compliance/steps TF Files : /Users/sharky/Repository/terraform-compliance/example/tf_files @@ -143,7 +150,7 @@ You can also push additional arguments that is specific for `radish`. Just to ex For e.g. ```sh [~] $ terraform-compliance -f /path/to/features -t /path/to/terraform_files -v -terraform-compliance v0.1.0 initiated +terraform-compliance v0.1.1 initiated Features : /Users/sharky/Repository/terraform-compliance/example/example_01 Steps : /Users/sharky/Repository/venv2/lib/python2.7/site-packages/terraform_compliance/steps TF Files : /Users/sharky/Repository/terraform-compliance/example/tf_files @@ -154,6 +161,24 @@ Running tests. ``` Please note that `0.8.6` is the `radish` version comes from `-v` parameter. +## Using remote repositories for features or terraform files +`terraform-compliance` also supports remote fetching if any of the feature or terraform files exist in a remote git repo. Sample usage is like ; + +```sh +[~] $ terraform-compliance -f git:https://some.git.repository/compliance-code.git -t /path/to/terraform_files -v +terraform-compliance v0.1.1 initiated +Using remote git repository: https://some.git.repository/compliance-code.git +Steps : /Users/sharky/Repository/terraform-compliance/terraform_compliance/steps +Features : /var/folders/1k/7vm1m4p12db2tqbd5jcn004m0000gn/T/tmpsrlnAG (https://some.git.repository/compliance-code.git) +TF Files : /Users/sharky/Repository/terraform-compliance/example/tf_files +Validating terraform files. +All HCL files look good. +Running tests. +Feature: Resources should be encrypted # /var/folders/1k/7vm1m4p12db2tqbd5jcn004m0000gn/T/tmpsrlnAG/aws/encryption.feature +``` + +This is also applicable for terraform files ( `-t` argument ), too. + ## License [MIT](https://tldrlegal.com/license/mit-license)