]>
Commit | Line | Data |
---|---|---|
1 | Terraform Provider Mailgun | |
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 | Website for the doc | |
11 | --------------------- | |
12 | https://fretlink.github.io/terraform-provider-mailgun/docs/providers/mailgun/index.html | |
13 | ||
14 | Requirements | |
15 | ------------ | |
16 | ||
17 | - [Terraform](https://www.terraform.io/downloads.html) 0.10.x | |
18 | - [Go](https://golang.org/doc/install) 1.12 (to build the provider plugin) | |
19 | ||
20 | Building The Provider | |
21 | --------------------- | |
22 | ||
23 | Clone repository to: `$GOPATH/src/github.com/fretlink/terraform-provider-mailgun` | |
24 | ||
25 | ```sh | |
26 | $ mkdir -p $GOPATH/src/github.com/fretlink; cd $GOPATH/src/github.com/fretlink | |
27 | $ git clone git@github.com:fretlink/terraform-provider-mailgun | |
28 | ``` | |
29 | ||
30 | Enter the provider directory and build the provider | |
31 | ||
32 | ```sh | |
33 | $ cd $GOPATH/src/github.com/fretlink/terraform-provider-mailgun | |
34 | $ make build | |
35 | ``` | |
36 | ||
37 | Using the provider | |
38 | ---------------------- | |
39 | ## Fill in for each provider | |
40 | ||
41 | Developing the Provider | |
42 | --------------------------- | |
43 | ||
44 | If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (version 1.12+ 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`. | |
45 | ||
46 | To compile the provider, run `make build`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory. | |
47 | ||
48 | ```sh | |
49 | $ make bin | |
50 | ... | |
51 | $ $GOPATH/bin/terraform-provider-mailgun | |
52 | ... | |
53 | ``` | |
54 | ||
55 | In order to test the provider, you can simply run `make test`. | |
56 | ||
57 | ```sh | |
58 | $ make test | |
59 | ``` | |
60 | ||
61 | In order to run the full suite of Acceptance tests, run `make testacc`. | |
62 | ||
63 | *Note:* Acceptance tests create real resources, and often cost money to run. | |
64 | ||
65 | ```sh | |
66 | $ make testacc | |
67 | ``` |