Skip to content

Commit

Permalink
Merge pull request #56 from hotosm/docs/auto-doc-update-workflows
Browse files Browse the repository at this point in the history 
auto-doc: updated workflows docs
  • Loading branch information
@spwoodcock
spwoodcock authored Oct 8, 2024
2 parents b6380ba + 812c640 commit 62971f2
Showing 1 changed file with 18 additions and 18 deletions.
36 changes: 18 additions & 18 deletions docs/test_compose.md
View file
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

0 comments on commit 62971f2

Please sign in to comment.