From 2889eded3f00ad0dedfb79dcac3e334afcb45179 Mon Sep 17 00:00:00 2001 From: Paul Banks Date: Wed, 15 Nov 2017 16:27:41 +0000 Subject: [PATCH] Tweaks to Registry Docs for 0.11 (#16663) * Registry 0.11 doc tweaks * Add changes for v0.11 --- website/docs/registry/index.html.md | 2 +- website/docs/registry/modules/use.html.md | 12 ++++++++---- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/website/docs/registry/index.html.md b/website/docs/registry/index.html.md index 1010e8fb3..f84e39423 100644 --- a/website/docs/registry/index.html.md +++ b/website/docs/registry/index.html.md @@ -25,7 +25,7 @@ module "consul" { } ``` -~> **Note:** Module registry integration was added in Terraform v0.10.6 +~> **Note:** Module registry integration was added in Terraform v0.10.6, and full versioning support in v0.11.0. You can also publish your own modules on the Terraform Registry. You may use the [public registry](https://registry.terraform.io) for public modules. diff --git a/website/docs/registry/modules/use.html.md b/website/docs/registry/modules/use.html.md index 556e53bd3..07c7dad62 100644 --- a/website/docs/registry/modules/use.html.md +++ b/website/docs/registry/modules/use.html.md @@ -39,6 +39,7 @@ have required inputs you must set before being able to use the module. ```hcl module "consul" { source = "hashicorp/consul/aws" + version = "0.1.0" } ``` @@ -48,7 +49,10 @@ Each module in the registry is versioned. These versions syntactically must follow [semantic versioning](http://semver.org/). In addition to pure syntax, we encourge all modules to follow the full guidelines of semantic versioning. -Terraform currently only downloads the latest version of each module. The -next release of Terraform (0.11) will bring full support for constraining -module versions. The registry has the required semantic versions since launch -to prepare for this transition shortly after. +Terraform since version 0.11 will resolve any provided +[module version constraints](/docs/modules/usage.html#module-versions) and +using them is highly recommended to avoid pulling in breaking changes. + +Terraform from version 10.6 through to 0.11 had partial support for the registry +protocol, however will not honour version constraints and always download the +latest version.