|
| 1 | +<!-- markdownlint-disable --> |
1 | 2 | # terraform-aws-tfstate-backend [](https://github.com/cloudposse/terraform-aws-tfstate-backend/releases/latest) [](https://slack.cloudposse.com)
|
| 3 | +<!-- markdownlint-restore --> |
2 | 4 |
|
3 | 5 | [![README Header][readme_header_img]][readme_header_link]
|
4 | 6 |
|
@@ -77,8 +79,15 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are
|
77 | 79 | ## Usage
|
78 | 80 |
|
79 | 81 |
|
80 |
| -**IMPORTANT:** The `master` branch is used in `source` just as an example. In your code, do not pin to `master` because there may be breaking changes between releases. |
81 |
| -Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest releases](https://github.com/cloudposse/terraform-aws-tfstate-backend/releases). |
| 82 | +**IMPORTANT:** We do not pin modules to versions in our examples because of the |
| 83 | +difficulty of keeping the versions in the documentation in sync with the latest released versions. |
| 84 | +We highly recommend that in your code you pin the version to the exact version you are |
| 85 | +using so that your infrastructure remains stable, and update versions in a |
| 86 | +systematic way so that they do not catch you by surprise. |
| 87 | + |
| 88 | +Also, because of a bug in the Terraform registry ([hashicorp/terraform#21417](https://github.com/hashicorp/terraform/issues/21417)), |
| 89 | +the registry shows many of our inputs as required when in fact they are optional. |
| 90 | +The table below correctly indicates which inputs are required. |
82 | 91 |
|
83 | 92 |
|
84 | 93 |
|
@@ -217,7 +226,7 @@ Available targets:
|
217 | 226 |
|
218 | 227 | | Name | Version |
|
219 | 228 | |------|---------|
|
220 |
| -| terraform | >= 0.12.0 | |
| 229 | +| terraform | >= 0.12.26 | |
221 | 230 | | aws | >= 2.0 |
|
222 | 231 | | local | >= 1.3 |
|
223 | 232 | | template | >= 2.0 |
|
@@ -433,8 +442,10 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
|
433 | 442 |
|
434 | 443 | ### Contributors
|
435 | 444 |
|
| 445 | +<!-- markdownlint-disable --> |
436 | 446 | | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Maarten van der Hoef][maartenvanderhoef_avatar]][maartenvanderhoef_homepage]<br/>[Maarten van der Hoef][maartenvanderhoef_homepage] | [![Vladimir][SweetOps_avatar]][SweetOps_homepage]<br/>[Vladimir][SweetOps_homepage] | [![Chris Weyl][rsrchboy_avatar]][rsrchboy_homepage]<br/>[Chris Weyl][rsrchboy_homepage] | [![John McGehee][jmcgeheeiv_avatar]][jmcgeheeiv_homepage]<br/>[John McGehee][jmcgeheeiv_homepage] | [![Oliver L Schoenborn][schollii_avatar]][schollii_homepage]<br/>[Oliver L Schoenborn][schollii_homepage] |
|
437 | 447 | |---|---|---|---|---|---|---|
|
| 448 | +<!-- markdownlint-restore --> |
438 | 449 |
|
439 | 450 | [aknysh_homepage]: https://github.com/aknysh
|
440 | 451 | [aknysh_avatar]: https://img.cloudposse.com/150x150/https://github.com/aknysh.png
|
|
0 commit comments