Skip to content

Commit

Permalink
docs: remove shared docs in template (testcontainers#1650)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdelapenya authored Sep 21, 2023
1 parent e5ddd86 commit 292cdd8
Showing 1 changed file with 0 additions and 14 deletions.
14 changes: 0 additions & 14 deletions modulegen/_template/module.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,6 @@ for {{ $title }}. E.g. `testcontainers.WithImage("{{ .Image }}")`.

{% include "../features/common_functional_options.md" %}

#### Startup Commands

!!!info
Not available until the next release of testcontainers-go <a href="https://github.com/testcontainers/testcontainers-go"><span class="tc-version">:material-tag: main</span></a>

Testcontainers exposes the `WithStartupCommand(e ...Executable)` option to run arbitrary commands in the container right after it's started.

!!!info
To better understand how this feature works, please read the [Create containers: Lifecycle Hooks](../../features/creating_container/#lifecycle-hooks) documentation.

It also exports an `Executable` interface, defining one single method: `AsCommand()`, which returns a slice of strings to represent the command and positional arguments to be executed in the container.

You could use this feature to run a custom script, or to run a command that is not supported by the module right after the {{ $title }} container is started.

### Container Methods

The {{ $title }} container exposes the following methods:

0 comments on commit 292cdd8

Please sign in to comment.