Added a similar README as for the other drone plugins

9 years ago · 99c73fbdf6
1 changed files with 120 additions and 4 deletions
--- a/README.md
+++ b/README.md
@ -1,7 +1,123 @@
-# Drone Terraform Deploy Plugin
+# drone-terraform

-This project provides a [Drone](drone.io) plugin docker image that contains the [Terraform](terraform.io) binaries and a small Go app that receives the Drone meta-data and executes Terraform commands.
+[![Build Status](http://beta.drone.io/api/badges/drone-plugins/drone-terraform/status.svg)](http://beta.drone.io/drone-plugins/drone-terraform)
+[![Coverage Status](https://aircover.co/badges/drone-plugins/drone-terraform/coverage.svg)](https://aircover.co/drone-plugins/drone-terraform)
+[![](https://badge.imagelayers.io/plugins/drone-terraform:latest.svg)](https://imagelayers.io/?images=plugins/drone-terraform:latest 'Get your own badge on imagelayers.io')

-Documentation for Drone Plugin development can be found here: http://readme.drone.io/plugin/
+Drone plugin to execute Terraform plan and apply. For the usage information and a listing of the available options please take a look at [the docs](DOCS.md).

-See [DOCS](DOCS.md) for details on this plugin's configuration and usage.
+## Binary
+
+Build the binary using `make`:
+
+```
+make deps build
+```
+
+### Example
+
+```sh
+./drone-terraform <<EOF
+{
+    "repo": {
+        "clone_url": "git://github.com/drone/drone",
+        "owner": "drone",
+        "name": "drone",
+        "full_name": "drone/drone"
+    },
+    "system": {
+        "link_url": "https://beta.drone.io"
+    },
+    "build": {
+        "number": 22,
+        "status": "success",
+        "started_at": 1421029603,
+        "finished_at": 1421029813,
+        "message": "Update the Readme",
+        "author": "johnsmith",
+        "author_email": "john.smith@gmail.com",
+        "event": "push",
+        "branch": "master",
+        "commit": "436b7a6e2abaddfd35740527353e78a227ddcb2c",
+        "ref": "refs/heads/master"
+    },
+    "workspace": {
+        "root": "/drone/src",
+        "path": "/drone/src/github.com/drone/drone"
+    },
+    "vargs": {
+        "plan": false,
+        "remote": {
+            "backend": "S3",
+            "config": {
+                "bucket": "my-terraform-config-bucket",
+                "key": "tf-states/my-project",
+                "region": "us-east-1"
+            }
+        },
+        "vars": {
+            "app_name": "my-project",
+            "app_version": "1.0.0"
+        }
+    }
+}
+EOF
+```
+
+## Docker
+
+Build the container using `make`:
+
+```
+make deps docker
+```
+
+### Example
+
+```sh
+docker run -i plugins/drone-terraform <<EOF
+{
+    "repo": {
+        "clone_url": "git://github.com/drone/drone",
+        "owner": "drone",
+        "name": "drone",
+        "full_name": "drone/drone"
+    },
+    "system": {
+        "link_url": "https://beta.drone.io"
+    },
+    "build": {
+        "number": 22,
+        "status": "success",
+        "started_at": 1421029603,
+        "finished_at": 1421029813,
+        "message": "Update the Readme",
+        "author": "johnsmith",
+        "author_email": "john.smith@gmail.com",
+        "event": "push",
+        "branch": "master",
+        "commit": "436b7a6e2abaddfd35740527353e78a227ddcb2c",
+        "ref": "refs/heads/master"
+    },
+    "workspace": {
+        "root": "/drone/src",
+        "path": "/drone/src/github.com/drone/drone"
+    },
+    "vargs": {
+        "plan": false,
+        "remote": {
+            "backend": "S3",
+            "config": {
+                "bucket": "my-terraform-config-bucket",
+                "key": "tf-states/my-project",
+                "region": "us-east-1"
+            }
+        },
+        "vars": {
+            "app_name": "my-project",
+            "app_version": "1.0.0"
+        }
+    }
+}
+EOF
+```