Skip to content

Commit 09f3484

Browse files
README: Updated note about compatibility
We now have 1.0 compatibility promises, so we can be more specific in what this library can do.
1 parent f987d4f commit 09f3484

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,14 @@ module, diags := tfconfig.LoadModule(dir)
2020
// ...
2121
```
2222

23-
There are not yet any formal compatibility promises for the Terraform
24-
configuration file format, so this tool can't yet promise to be compatible
25-
with unknown future extensions to the format. However, it *should* be capable
26-
of parsing valid configurations targeting Terraform versions between 0.10
27-
and 1.0.
23+
Due to the [Terraform v1.0 Compatibility Promises](https://www.terraform.io/docs/language/v1-compatibility-promises.html),
24+
this library should be able to parse Terraform configurations written in
25+
the language as defined with Terraform v1.0, although it may not immediately
26+
expose _new_ additions to the language added during the v1.x series.
27+
28+
This library can also interpret valid Terraform configurations targeting
29+
Terraform v0.10 through v0.15, although the level of detail returned may
30+
be lower in older language versions.
2831

2932
## Command Line Tool
3033

0 commit comments

Comments
 (0)