Skip to content

docs(readme): add Install, Stability and versioning sections for v1 #1802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
james00012 merged 4 commits into from
Apr 28, 2026
Merged

docs(readme): add Install, Stability and versioning sections for v1 #1802

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2dad2c
docs(readme): add Install, Stability and versioning sections for v1
james00012 Apr 27, 2026
f7dc1be
docs(readme): point Stability section at MIGRATION.md
james00012 Apr 27, 2026
439d906
Merge branch 'main' into james/oss-3393-readme-v1
james00012 Apr 28, 2026
182fd29
Merge branch 'main' into james/oss-3393-readme-v1
james00012 Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,23 @@ variety of helper functions and patterns for common infrastructure testing tasks
- Running shell commands
- And much more

Please see the following for more info:
## Install

```bash
go get github.com/gruntwork-io/terratest@latest
```

Requires Go 1.26 or later.

## Stability and versioning

Starting with v1.0.0, Terratest follows [semantic versioning](https://semver.org/). Breaking changes to the public API
only happen in major releases (e.g. v2.0.0).

Symbols renamed or replaced in v1 are kept with `// Deprecated:` annotations pointing at the new name; removals happen
in v2. Migrating from v0.x: see [`MIGRATION.md`](./MIGRATION.md).

## More info

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