]> git.immae.eu Git - github/fretlink/terraform-provider-statuscake.git/blob - README.md
add go-querystring
[github/fretlink/terraform-provider-statuscake.git] / README.md
1 Terraform Provider
2 ==================
3
4 - Website: https://www.terraform.io
5 - [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
6 - Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)
7
8 <img src="https://cdn.rawgit.com/hashicorp/terraform-website/master/content/source/assets/images/logo-hashicorp.svg" width="600px">
9
10 Requirements
11 ------------
12
13 - [Terraform](https://www.terraform.io/downloads.html) 0.10.x
14 - [Go](https://golang.org/doc/install) 1.11 (to build the provider plugin)
15
16 Building The Provider
17 ---------------------
18
19 Clone repository to: `$GOPATH/src/github.com/terraform-providers/terraform-provider-statuscake`
20
21 ```sh
22 $ mkdir -p $GOPATH/src/github.com/terraform-providers; cd $GOPATH/src/github.com/terraform-providers
23 $ git clone git@github.com:terraform-providers/terraform-provider-statuscake
24 ```
25
26 Enter the provider directory and build the provider
27
28 ```sh
29 $ cd $GOPATH/src/github.com/terraform-providers/terraform-provider-statuscake
30 $ make build
31 ```
32
33 Using the provider
34 ----------------------
35 ## Fill in for each provider
36
37 Developing the Provider
38 ---------------------------
39
40 If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.11+ is *required*). You'll also need to correctly setup a [GOPATH](http://golang.org/doc/code.html#GOPATH), as well as adding `$GOPATH/bin` to your `$PATH`.
41
42 To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.
43
44 ```sh
45 $ make bin
46 ...
47 $ $GOPATH/bin/terraform-provider-statuscake
48 ...
49 ```
50
51 In order to test the provider, you can simply run `make test`.
52
53 ```sh
54 $ make test
55 ```
56
57 In order to run the full suite of Acceptance tests, run `make testacc`.
58
59 *Note:* Acceptance tests create real resources, and often cost money to run.
60
61 ```sh
62 $ make testacc
63 ```