docs(options): add versions to all module options

Author: mdelapenya

docs/modules/artemis.md

@@ -52,23 +52,29 @@ In example: `Run(context.Background(), "apache/activemq-artemis:2.30.0")`.
 
 When starting the Artemis container, you can pass options in a variadic way to configure it.
 
-#### Credentials
+#### WithCredentials
+
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
 
 If you need to change the default admin credentials (i.e. `artemis:artemis`) use `WithCredentials`.
 
 <!--codeinclude-->
 [With credentials](../../modules/artemis/artemis_test.go) inside_block:withCredentials
 <!--/codeinclude-->
 
-#### Enable Anonymous login
+#### WithAnonymousLogin
+
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
 
 If you need to enable anonymous logins (which are disabled by default) use `WithAnonymousLogin`.
 
 <!--codeinclude-->
 [With Anonymous Login](../../modules/artemis/artemis_test.go) inside_block:withAnonymousLogin
 <!--/codeinclude-->
 
-#### Custom Arguments
+#### WithExtraArgs
+
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
 
 If you need to pass custom arguments to the `artemis create` command, use `WithExtraArgs`.
 The default is `--http-host 0.0.0.0 --relax-jolokia`.
@@ -89,6 +95,8 @@ The Artemis container exposes the following methods:
 
 #### User
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
+
 User returns the administrator username.
 
 <!--codeinclude-->
@@ -97,6 +105,8 @@ User returns the administrator username.
 
 #### Password
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
+
 Password returns the administrator password.
 
 <!--codeinclude-->
@@ -105,6 +115,8 @@ Password returns the administrator password.
 
 #### BrokerEndpoint
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
+
 BrokerEndpoint returns the host:port for the combined protocols endpoint.
 
 <!--codeinclude-->
@@ -113,6 +125,8 @@ BrokerEndpoint returns the host:port for the combined protocols endpoint.
 
 #### ConsoleURL
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
+
 ConsoleURL returns the URL for the management console.
 
 <!--codeinclude-->

docs/modules/cassandra.md

@@ -48,7 +48,9 @@ In example: `Run(context.Background(), "cassandra:4.1.3")`.
 
 When starting the Cassandra container, you can pass options in a variadic way to configure it.
 
-#### Init Scripts
+#### WithInitScripts
+
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.26.0"><span class="tc-version">:material-tag: v0.26.0</span></a>
 
 If you would like to do additional initialization in the Cassandra container, add one or more `*.cql` or `*.sh` scripts to the container request with the `WithInitScripts` function.
 Those files will be copied after the container is created but before it's started under root directory.
@@ -59,7 +61,9 @@ An example of a `*.sh` script that creates a keyspace and table is shown below:
 [Init script content](../../modules/cassandra/testdata/init.sh)
 <!--/codeinclude-->
 
-#### Database configuration
+#### WithConfigFile
+
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.26.0"><span class="tc-version">:material-tag: v0.26.0</span></a>
 
 In the case you have a custom config file for Cassandra, it's possible to copy that file into the container before it's started, using the `WithConfigFile(cfgPath string)` function.
 
@@ -74,6 +78,8 @@ The Cassandra container exposes the following methods:
 
 #### ConnectionHost
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.26.0"><span class="tc-version">:material-tag: v0.26.0</span></a>
+
 This method returns the host and port of the Cassandra container, using the default, `9042/tcp` port. E.g. `localhost:9042`
 
 <!--codeinclude-->

docs/modules/chroma.md

@@ -61,6 +61,8 @@ The Chroma container exposes the following methods:
 
 #### REST Endpoint
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.29.0"><span class="tc-version">:material-tag: v0.29.0</span></a>
+
 This method returns the REST endpoint of the Chroma container, using the default `8000` port.
 
 <!--codeinclude-->

docs/modules/clickhouse.md

@@ -58,13 +58,17 @@ When starting the ClickHouse container, you can pass options in a variadic way t
 
 #### Set username, password and database name
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
+
 If you need to set a different database, and its credentials, you can use `WithUsername`, `WithPassword`, `WithDatabase`
 options. E.g. `WithUsername("user")`, `WithPassword("password")`, `WithDatabase("db")`.
 
 !!!info
     The default values for the username is `default`, for password is `clickhouse` and for the default database name is `clickhouse`.
 
-#### Init Scripts
+#### WithInitScripts
+
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
 
 If you would like to do additional initialization in the ClickHouse container, add one or more `*.sql`, `*.sql.gz`, or `*.sh` scripts to the container request.
 Those files will be copied after the container is created but before it's started under `/docker-entrypoint-initdb.d`. According to ClickHouse Docker image,
@@ -81,6 +85,8 @@ initialization before starting the service.
 
 #### Zookeeper
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 Clusterized ClickHouse requires to start Zookeeper and pass link to it via `config.xml`.
 
 <!--codeinclude-->
@@ -90,7 +96,9 @@ Clusterized ClickHouse requires to start Zookeeper and pass link to it via `conf
 !!!warning
     The `WithZookeeper` option will `panic` if it's not possible to create the Zookeeper config file.
 
-#### Custom configuration
+#### WithConfigFile
+
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
 
 If you need to set a custom configuration, the module provides the `WithConfigFile` option to pass the path to a custom configuration file in XML format.
 
@@ -112,6 +120,8 @@ The ClickHouse container exposes the following methods:
 
 #### ConnectionHost
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
+
 This method returns the host and port of the ClickHouse container, using the default, native `9000/tcp` port. E.g. `localhost:9000`
 
 <!--codeinclude-->
@@ -120,6 +130,8 @@ This method returns the host and port of the ClickHouse container, using the def
 
 #### ConnectionString
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.23.0"><span class="tc-version">:material-tag: v0.23.0</span></a>
+
 This method returns the dsn connection string to connect to the ClickHouse container, using the default, native `9000/tcp` port obtained from the `ConnectionHost` method.
 It's possible to pass extra parameters to the connection string, e.g. `dial_timeout=300ms` or `skip_verify=false`, in a variadic way.
 

docs/modules/cockroachdb.md

@@ -48,59 +48,81 @@ When starting the CockroachDB container, you can pass options in a variadic way
 Use the second argument in the `Run` function to set a valid Docker image.
 In example: `Run(context.Background(), "cockroachdb/cockroach:latest-v23.1")`.
 
-{% include "../features/common_functional_options_list.md" %}
-
 #### Database
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 Set the database that is created & dialled with `cockroachdb.WithDatabase`.
 
 #### User and Password
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 You can configure the container to create a user with a password by setting `cockroachdb.WithUser` and `cockroachdb.WithPassword`.
 
 `cockroachdb.WithPassword` is incompatible with `cockroachdb.WithInsecure`.
 
 #### Store size
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 Control the maximum amount of memory used for storage, by default this is 100% but can be changed by provided a valid option to `WithStoreSize`. Checkout https://www.cockroachlabs.com/docs/stable/cockroach-start#store for the full range of options available.
 
 #### TLS authentication
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.35.0"><span class="tc-version">:material-tag: v0.35.0</span></a>
+
 `cockroachdb.WithInsecure` lets you disable the use of TLS on connections.
 
 `cockroachdb.WithInsecure` is incompatible with `cockroachdb.WithPassword`.
 
 #### Initialization Scripts
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.35.0"><span class="tc-version">:material-tag: v0.35.0</span></a>
+
 `cockroachdb.WithInitScripts` adds the given scripts to those automatically run when the container starts.
 These will be ignored if data exists in the `/cockroach/cockroach-data` directory within the container.
 
+#### No Cluster Defaults
+
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.35.0"><span class="tc-version">:material-tag: v0.35.0</span></a>
+
 `cockroachdb.WithNoClusterDefaults` disables the default cluster settings script.
 
 Without this option Cockroach containers run `data/cluster-defaults.sql` on startup
 which configures the settings recommended by Cockroach Labs for
 [local testing clusters](https://www.cockroachlabs.com/docs/stable/local-testing)
 unless data exists in the `/cockroach/cockroach-data` directory within the container.
 
+{% include "../features/common_functional_options_list.md" %}
+
 ### Container Methods
 
 The CockroachDB container exposes the following methods:
 
 #### ConnectionString
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 Dial address to open a new connection.
 
 #### MustConnectionString
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 Same as `ConnectionString` but any error to generate the address will raise a panic
 
 #### TLSConfig
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 Returns `*tls.Config` setup to allow you to dial your client over TLS, if enabled, else this will error with `cockroachdb.ErrTLSNotEnabled`.
 
 !!!info
     The `TLSConfig()` function is deprecated and will be removed in the next major release of _Testcontainers for Go_.
 
 #### ConnectionConfig
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.35.0"><span class="tc-version">:material-tag: v0.35.0</span></a>
+
 Returns `*pgx.ConnConfig` which can be passed to `pgx.ConnectConfig` to open a new connection.

docs/modules/consul.md

@@ -50,6 +50,8 @@ When starting the Consul container, you can pass options in a variadic way to co
 
 #### Configuration File
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 If you need to customize the behavior for the deployed node you can use either `WithConfigString(config string)` or `WithConfigFile(configPath string)`.
 The configuration has to be in JSON format and will be loaded at the node startup.
 
@@ -61,6 +63,8 @@ The Consul container exposes the following method:
 
 #### ApiEndpoint
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.28.0"><span class="tc-version">:material-tag: v0.28.0</span></a>
+
 This method returns the connection string to connect to the Consul container API, using the default `8500` port.
 
 <!--codeinclude-->

docs/modules/couchbase.md

@@ -84,6 +84,8 @@ When starting the Couchbase container, you can pass options in a variadic way to
 
 #### Credentials
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.20.0"><span class="tc-version">:material-tag: v0.20.0</span></a>
+
 If you need to change the default credentials for the admin user, you can use `WithAdminCredentials(user, password)` with a valid username and password.
 When the password has less than 6 characters, the container won't be created and the `New` function will throw an error.
 
@@ -92,6 +94,8 @@ When the password has less than 6 characters, the container won't be created and
 
 #### Buckets
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.20.0"><span class="tc-version">:material-tag: v0.20.0</span></a>
+
 When creating a new Couchbase container, you can create one or more buckets. The module exposes a `WithBuckets` optional function that accepts a slice of buckets to be created.
 To create a new bucket, the module also exposes a `NewBucket` function, where you can pass the bucket name.
 
@@ -108,6 +112,8 @@ It's possible to customize a newly created bucket, using the following options:
 
 #### Index Storage
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.20.0"><span class="tc-version">:material-tag: v0.20.0</span></a>
+
 It's possible to set the storage mode to be used for all global secondary indexes in the cluster.
 
 !!!warning
@@ -119,6 +125,8 @@ It's possible to set the storage mode to be used for all global secondary indexe
 
 #### Services
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.20.0"><span class="tc-version">:material-tag: v0.20.0</span></a>
+
 By default, the container will start with the following services: `kv`, `n1ql`, `fts` and `index`.
 
 !!!warning
@@ -131,13 +139,19 @@ By default, the container will start with the following services: `kv`, `n1ql`,
 
 #### ConnectionString
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.20.0"><span class="tc-version">:material-tag: v0.20.0</span></a>
+
 The `ConnectionString` method returns the connection string to connect to the Couchbase container instance. 
 It returns a string with the format `couchbase://<host>:<port>`.
 
 #### Username
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.20.0"><span class="tc-version">:material-tag: v0.20.0</span></a>
+
 The `Username` method returns the username of the Couchbase administrator. 
 
 #### Password
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.20.0"><span class="tc-version">:material-tag: v0.20.0</span></a>
+
 The `Password` method returns the password of the Couchbase administrator.

docs/modules/databend.md

@@ -47,6 +47,8 @@ When starting the Databend container, you can pass options in a variadic way to
 
 #### Set username, password
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.34.0"><span class="tc-version">:material-tag: v0.34.0</span></a>
+
 If you need to set a different user/password/database, you can use `WithUsername`, `WithPassword` options.
 
 !!!info
@@ -60,6 +62,8 @@ The Databend container exposes the following methods:
 
 #### ConnectionString
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.34.0"><span class="tc-version">:material-tag: v0.34.0</span></a>
+
 This method returns the connection string to connect to the Databend container, using the default `8000` port.
 It's possible to pass extra parameters to the connection string, e.g. `sslmode=disable`.
 
@@ -69,4 +73,6 @@ It's possible to pass extra parameters to the connection string, e.g. `sslmode=d
 
 #### MustGetConnectionString
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.34.0"><span class="tc-version">:material-tag: v0.34.0</span></a>
+
 `MustConnectionString` panics if the address cannot be determined.

docs/modules/dind.md

@@ -53,6 +53,8 @@ The DinD container exposes the following methods:
 
 #### Host
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.36.0"><span class="tc-version">:material-tag: v0.36.0</span></a>
+
 The `Host` method returns the DinD URL, to be used for connecting
 to the Docker API using a Docker client. It'll be returned in the format of `string`.
 
@@ -63,6 +65,8 @@ to the Docker API using a Docker client. It'll be returned in the format of `str
 
 #### LoadImage
 
+- Since <a href="https://github.com/testcontainers/testcontainers-go/releases/tag/v0.36.0"><span class="tc-version">:material-tag: v0.36.0</span></a>
+
 The `LoadImage` method loads an image into the docker in docker daemon.
 
 This is useful for testing images generated locally without having to push them to a public docker registry.