Skip to content

Commit b2dad2c

Browse files
committed
docs(readme): add Install, Stability and versioning sections for v1
Documents the v1.0.0 SemVer commitment and the deprecate-don't-delete policy so consumers know what to expect from the v1 line. Adds an explicit Install section with the minimum supported Go version (1.26) and points migrators at the docs site for v1 release notes and migration guide. Linear: OSS-3393
1 parent d982515 commit b2dad2c

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,24 @@ variety of helper functions and patterns for common infrastructure testing tasks
2222
- Running shell commands
2323
- And much more
2424

25-
Please see the following for more info:
25+
## Install
26+
27+
```bash
28+
go get github.com/gruntwork-io/terratest@latest
29+
```
30+
31+
Requires Go 1.26 or later.
32+
33+
## Stability and versioning
34+
35+
Starting with v1.0.0, Terratest follows [semantic versioning](https://semver.org/). Breaking changes to the public API
36+
only happen in major releases (e.g. v2.0.0).
37+
38+
Symbols renamed or replaced in v1 are kept with `// Deprecated:` annotations pointing at the new name; removals happen
39+
in v2. Migrating from v0.x: see the [v1 release notes and migration guide](https://terratest.gruntwork.io/docs/) on the
40+
Terratest docs site.
41+
42+
## More info
2643

2744
- [Terratest Website](https://terratest.gruntwork.io)
2845
- [Getting started with Terratest](https://terratest.gruntwork.io/docs/getting-started/quick-start/)

0 commit comments

Comments
 (0)