Skip to content

Commit 4d0fbbf

Browse files
docs(readme): add rc section and fixed source versions
1 parent 8dde37a commit 4d0fbbf

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ terraform {
5252
}
5353
5454
module "fingerprint_fastly_vcl_integration" {
55-
source = "github.com/fingerprintjs/temp-fastly-vcl-terraform"
55+
source = "fingerprintjs/vcl-fingerprint-proxy-integration/fastly"
56+
version = "~> 1.0"
5657
fastly_api_token = "FASTLY_API_TOKEN"
5758
proxy_secret = "FINGERPRINT_PROXY_SECRET"
5859
integration_path = "INTEGRATION_PATH"
@@ -81,6 +82,32 @@ You can see the full list of the Terraform module's variables below:
8182
| `asset_version` | GitHub release version used for the VCL asset | Optional | `"latest"` |
8283
| `manage_fastly_dictionary_items` | Manage Fastly Dictionary items via terraform, see [Fastly documentation](https://registry.terraform.io/providers/fastly/fastly/latest/docs/resources/service_dictionary_items#manage_items-1) | Optional | `false` |
8384

85+
### Using Release Candidates (Optional)
86+
87+
To use a release candidate version of the module, specify it explicitly in the version field:
88+
89+
```terraform
90+
module "fingerprint_fastly_vcl_integration" {
91+
source = "fingerprintjs/vcl-fingerprint-proxy-integration/fastly"
92+
version = "1.0.0-rc.1"
93+
# Other module inputs
94+
}
95+
```
96+
97+
Alternatively, you can point directly to the GitHub repository and use a branch (e.g., `rc`) via the ref parameter.
98+
This ensures you're always using the latest commit from that branch:
99+
100+
```terraform
101+
module "fingerprint_fastly_vcl_integration" {
102+
source = "github.com/fingerprintjs/terraform-fastly-vcl-fingerprint-proxy-integration?ref=rc"
103+
# Other module inputs
104+
}
105+
```
106+
107+
> [!WARNING]
108+
> Using a GitHub source with `ref` disables version locking and may result in unexpected changes when the branch is updated.
109+
> Recommended for development or testing only.
110+
84111
## 2. Deploy your Terraform changes
85112

86113
1. Initialize the Terraform module:

0 commit comments

Comments
 (0)