Skip to content

Commit

Permalink
docs: document the Go version (testcontainers#1246)
Browse files Browse the repository at this point in the history
* docs: document the Go version

* docs: separate concerns
  • Loading branch information
mdelapenya authored May 26, 2023
1 parent 72e5a02 commit 2afa0f2
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
10 changes: 10 additions & 0 deletions docs/system_requirements/docker.md
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/).
13 changes: 4 additions & 9 deletions docs/system_requirements/index.md
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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ nav:
- examples/toxiproxy.md
- System Requirements:
- system_requirements/index.md
- system_requirements/docker.md
- system_requirements/using_colima.md
- system_requirements/using_podman.md
- Contributing:
Expand Down

0 comments on commit 2afa0f2

Please sign in to comment.