From af214bacb3798b06f623df7b2b7a9b1cdd1fab21 Mon Sep 17 00:00:00 2001 From: Vandy Liu Date: Wed, 3 Apr 2024 00:22:38 -0700 Subject: [PATCH] update readme --- .gitignore | 1 + README.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) diff --git a/.gitignore b/.gitignore index 6420f248..e007ae45 100644 --- a/.gitignore +++ b/.gitignore @@ -29,6 +29,7 @@ website/vendor examples/main.tf test_results vendor/ +.terraformrc # Test exclusions !command/test-fixtures/**/*.tfstate diff --git a/README.md b/README.md index 9759acd8..1b71f34b 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,18 @@ In order to run the full suite of Acceptance tests, run `make testacc`. *Note:* Acceptance tests create real resources, and often cost money to run. +To run terraform with the provider, create a `.terraformrc` file in your home directory with the following content to override the provider installation with the local build: + +```hcl +provider_installation { + dev_overrides { + "registry.terraform.io/astronomer/astronomer" = "~/astronomer/astronomer-terraform-provider/bin" # Path to the provider binary + } +direct {} +} +``` + + ```shell make testacc ```