Skip to content
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

Jump to bottom

auto-doc: updated workflows docs #56

Merged
merged 1 commit into from
Oct 8, 2024
Merged

auto-doc: updated workflows docs #56

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 18 additions & 18 deletions docs/test_compose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,24 +147,24 @@ services:

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------------------------------------- | ------- | -------- | ---------------------- | ------------------------------------------------------------------------------------------------ |
| <a name="input_build_context"></a>[build_context](#input_build_context) | string | false | `"."` | Root directory to start the <br>build from. |
| <a name="input_build_dockerfile"></a>[build_dockerfile](#input_build_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to <br>context dir. |
| <a name="input_build_img"></a>[build_img](#input_build_img) | boolean | false | `true` | If the image must be <br>built first, or false to <br>just pull. |
| <a name="input_build_target"></a>[build_target](#input_build_target) | string | false | `"ci"` | The target to built to <br>(default to ci stage). |
| <a name="input_cache_extra_imgs"></a>[cache_extra_imgs](#input_cache_extra_imgs) | string | false | | Space separated list of images <br>to cache on each run <br>(e.g. to avoid rate limiting). |
| <a name="input_cache_image"></a>[cache_image](#input_cache_image) | boolean | false | `true` | Cache the built image, for <br>the next run. Default true. |
| <a name="input_compose_command"></a>[compose_command](#input_compose_command) | string | false | | The command to run for <br>the container. Default to built-in <br>image command. |
| <a name="input_compose_file"></a>[compose_file](#input_compose_file) | string | false | `"docker-compose.yml"` | The docker compose file used <br>to run the test. |
| <a name="input_compose_service"></a>[compose_service](#input_compose_service) | string | true | | The docker compose service to <br>run the test against. |
| <a name="input_coverage"></a>[coverage](#input_coverage) | boolean | false | `false` | Generate a coverage HTML report <br>(requires coverage.py installed). |
| <a name="input_environment"></a>[environment](#input_environment) | string | false | `"test"` | The environment to use for <br>testing. |
| <a name="input_example_env_file_path"></a>[example_env_file_path](#input_example_env_file_path) | string | false | `".env.example"` | Path to example dotenv file <br>to substitute variables for. |
| <a name="input_extra_build_args"></a>[extra_build_args](#input_extra_build_args) | string | false | | Space separated list of build <br>args to use for the <br>image. |
| <a name="input_image_name"></a>[image_name](#input_image_name) | string | true | | The image root name, without <br>tag. E.g. 'ghcr.io/[dollar]{{ github.repository }}' |
| <a name="input_pre_command"></a>[pre_command](#input_pre_command) | string | false | | A initialisation command to run <br>prior to the docker compose <br>command. |
| <a name="input_tag_override"></a>[tag_override](#input_tag_override) | string | false | | An override for the build <br>image tag. Must include tests <br>and have test software installed |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------------------------------------- | ------- | -------- | ---------------------- | ------------------------------------------------------------------------------------------------- |
| <a name="input_build_context"></a>[build_context](#input_build_context) | string | false | `"."` | Root directory to start the <br>build from. |
| <a name="input_build_dockerfile"></a>[build_dockerfile](#input_build_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to <br>context dir. |
| <a name="input_build_target"></a>[build_target](#input_build_target) | string | false | `"ci"` | The target to built to <br>(default to ci stage). |
| <a name="input_cache_extra_imgs"></a>[cache_extra_imgs](#input_cache_extra_imgs) | string | false | | Space separated list of images <br>to cache on each run <br>(e.g. to avoid rate limiting). |
| <a name="input_cache_image"></a>[cache_image](#input_cache_image) | boolean | false | `true` | Cache the built image, for <br>the next run. Default true. |
| <a name="input_compose_command"></a>[compose_command](#input_compose_command) | string | false | | The command to run for <br>the container. Default to built-in <br>image command. |
| <a name="input_compose_file"></a>[compose_file](#input_compose_file) | string | false | `"docker-compose.yml"` | The docker compose file used <br>to run the test. |
| <a name="input_compose_service"></a>[compose_service](#input_compose_service) | string | true | | The docker compose service to <br>run the test against. |
| <a name="input_coverage"></a>[coverage](#input_coverage) | boolean | false | `false` | Generate a coverage HTML report <br>(requires coverage.py installed). |
| <a name="input_environment"></a>[environment](#input_environment) | string | false | `"test"` | The environment to use for <br>testing. |
| <a name="input_example_env_file_path"></a>[example_env_file_path](#input_example_env_file_path) | string | false | `".env.example"` | Path to example dotenv file <br>to substitute variables for. |
| <a name="input_extra_build_args"></a>[extra_build_args](#input_extra_build_args) | string | false | | Space separated list of build <br>args to use for the <br>image. |
| <a name="input_image_name"></a>[image_name](#input_image_name) | string | false | | The image root name to <br>build, without tag. E.g. 'ghcr.io/[dollar]{{ <br>github.repository }}' |
| <a name="input_playwright"></a>[playwright](#input_playwright) | boolean | false | `false` | Upload the Playwright trace files <br>as an artifact for debugging. |
| <a name="input_pre_command"></a>[pre_command](#input_pre_command) | string | false | | A initialisation command to run <br>prior to the docker compose <br>command. |
| <a name="input_tag_override"></a>[tag_override](#input_tag_override) | string | false | | An override for the build <br>image tag. Must include tests <br>and have test software installed |

<!-- AUTO-DOC-INPUT:END -->

Expand Down