forked from testcontainers/testcontainers-go
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: document the Go version (testcontainers#1246)
* docs: document the Go version * docs: separate concerns
- Loading branch information
1 parent
72e5a02
commit 2afa0f2
Showing
3 changed files
with
15 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# General Docker requirements | ||
|
||
Testcontainers requires a Docker-API compatible container runtime. | ||
During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows. | ||
These Docker environments are automatically detected and used by Testcontainers without any additional configuration being necessary. | ||
|
||
It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives. | ||
However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available and additional manual configuration might be necessary. | ||
If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests, | ||
please contact the Testcontainers team and other users from the Testcontainers community on [Slack](https://slack.testcontainers.org/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,7 @@ | ||
# General Docker requirements | ||
# Go version | ||
|
||
## Overview | ||
From the [Go Release Policy](https://go.dev/doc/devel/release#policy): | ||
|
||
Testcontainers requires a Docker-API compatible container runtime. | ||
During development, Testcontainers is actively tested against recent versions of Docker on Linux, as well as against Docker Desktop on Mac and Windows. | ||
These Docker environments are automatically detected and used by Testcontainers without any additional configuration being necessary. | ||
> Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release. We fix critical problems, including critical security problems, in supported releases as needed by issuing minor revisions (for example, Go 1.6.1, Go 1.6.2, and so on). | ||
It is possible to configure Testcontainers to work for other Docker setups, such as a remote Docker host or Docker alternatives. | ||
However, these are not actively tested in the main development workflow, so not all Testcontainers features might be available and additional manual configuration might be necessary. | ||
If you have further questions about configuration details for your setup or whether it supports running Testcontainers-based tests, | ||
please contact the Testcontainers team and other users from the Testcontainers community on [Slack](https://slack.testcontainers.org/). | ||
_Testcontainers for Go_ is tested against those two latest Go releases, therefore we recommend using any of them. You could check what versions are actually supported by looking at the [GitHub Action](../../.github/workflows/ci.yml) configuration, under the `test.strategy.matrix.go-version` key. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters