Skip to content

Commit bf92052

Browse files
docs: move rc and version sections to contributing.md
1 parent 4d0fbbf commit bf92052

File tree

2 files changed

+21
-27
lines changed

2 files changed

+21
-27
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,24 @@ To test terraform module using Fingerprint's staging environment, you need to [c
6161
```
6262
- [Use your own custom asset](./README.md#custom-vcl) to deploy your integration
6363

64+
## Using Release Candidates
65+
66+
To use a release candidate version of the module, specify it explicitly in the version field:
67+
68+
```terraform
69+
module "fingerprint_fastly_vcl_integration" {
70+
source = "fingerprintjs/vcl-fingerprint-proxy-integration/fastly"
71+
version = "1.0.0-rc.1"
72+
# Other module inputs
73+
}
74+
```
75+
76+
Alternatively, you can point directly to the GitHub repository and use a branch (e.g., `rc`) via the ref parameter.
77+
This ensures you're always using the latest commit from that branch:
78+
79+
```terraform
80+
module "fingerprint_fastly_vcl_integration" {
81+
source = "github.com/fingerprintjs/terraform-fastly-vcl-fingerprint-proxy-integration?ref=rc"
82+
# Other module inputs
83+
}
84+
```

README.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ terraform {
5353
5454
module "fingerprint_fastly_vcl_integration" {
5555
source = "fingerprintjs/vcl-fingerprint-proxy-integration/fastly"
56-
version = "~> 1.0"
5756
fastly_api_token = "FASTLY_API_TOKEN"
5857
proxy_secret = "FINGERPRINT_PROXY_SECRET"
5958
integration_path = "INTEGRATION_PATH"
@@ -82,32 +81,6 @@ You can see the full list of the Terraform module's variables below:
8281
| `asset_version` | GitHub release version used for the VCL asset | Optional | `"latest"` |
8382
| `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` |
8483

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-
11184
## 2. Deploy your Terraform changes
11285

11386
1. Initialize the Terraform module:

0 commit comments

Comments
 (0)