Skip to content

Commit

Permalink
docs(README): describe local testing
Browse files Browse the repository at this point in the history
  • Loading branch information
Integralist committed Jan 24, 2023
1 parent 34d432b commit e04e6cf
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
The Fastly Terraform Provider interacts with most facets of the [Fastly API](https://developer.fastly.com/reference/api) and uses the [Terraform Plugin Framework](https://github.com/hashicorp/terraform-plugin-framework).

## Using the provider

Consumers should refer to the [EXAMPLES](./examples/)

## Requirements

- [Terraform](https://www.terraform.io/downloads.html) >= 1.0
Expand All @@ -19,10 +23,6 @@ The Fastly Terraform Provider interacts with most facets of the [Fastly API](htt
go install
```

## Using the provider

TODO

## Developing the Provider

We document issues with the provider in [`DEVELOPMENT.md`](./DEVELOPMENT.md).
Expand All @@ -31,6 +31,8 @@ If you wish to work on the provider, you'll first need [Go](http://www.golang.or

To compile the provider, run `go install`. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.

To manually test the provider (e.g. using the provider with your own Terraform configuration), run `make build`, which runs `go install` but also produces a `~/.terraformrc` that enables the Terraform CLI to use the local build version.

To generate or update documentation, run `go generate` (or `make docs`).

To run the full suite of Acceptance tests, run `make testacc`.
Expand Down

0 comments on commit e04e6cf

Please sign in to comment.