From 812c6408285d1b5349d6227998d9df426819596d Mon Sep 17 00:00:00 2001
From: spwoodcock <78538841+spwoodcock@users.noreply.github.com>
Date: Thu, 1 Aug 2024 11:46:50 +0000
Subject: [PATCH] docs: updated workflow docs
---
docs/test_compose.md | 36 ++++++++++++++++++------------------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/docs/test_compose.md b/docs/test_compose.md
index 69bf9fd..988d581 100644
--- a/docs/test_compose.md
+++ b/docs/test_compose.md
@@ -147,24 +147,24 @@ services:
-| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
-| ----------------------------------------------------------------------------------------------- | ------- | -------- | ---------------------- | ------------------------------------------------------------------------------------------------ |
-| [build_context](#input_build_context) | string | false | `"."` | Root directory to start the
build from. |
-| [build_dockerfile](#input_build_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to
context dir. |
-| [build_img](#input_build_img) | boolean | false | `true` | If the image must be
built first, or false to
just pull. |
-| [build_target](#input_build_target) | string | false | `"ci"` | The target to built to
(default to ci stage). |
-| [cache_extra_imgs](#input_cache_extra_imgs) | string | false | | Space separated list of images
to cache on each run
(e.g. to avoid rate limiting). |
-| [cache_image](#input_cache_image) | boolean | false | `true` | Cache the built image, for
the next run. Default true. |
-| [compose_command](#input_compose_command) | string | false | | The command to run for
the container. Default to built-in
image command. |
-| [compose_file](#input_compose_file) | string | false | `"docker-compose.yml"` | The docker compose file used
to run the test. |
-| [compose_service](#input_compose_service) | string | true | | The docker compose service to
run the test against. |
-| [coverage](#input_coverage) | boolean | false | `false` | Generate a coverage HTML report
(requires coverage.py installed). |
-| [environment](#input_environment) | string | false | `"test"` | The environment to use for
testing. |
-| [example_env_file_path](#input_example_env_file_path) | string | false | `".env.example"` | Path to example dotenv file
to substitute variables for. |
-| [extra_build_args](#input_extra_build_args) | string | false | | Space separated list of build
args to use for the
image. |
-| [image_name](#input_image_name) | string | true | | The image root name, without
tag. E.g. 'ghcr.io/[dollar]{{ github.repository }}' |
-| [pre_command](#input_pre_command) | string | false | | A initialisation command to run
prior to the docker compose
command. |
-| [tag_override](#input_tag_override) | string | false | | An override for the build
image tag. Must include tests
and have test software installed |
+| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
+| ----------------------------------------------------------------------------------------------- | ------- | -------- | ---------------------- | ------------------------------------------------------------------------------------------------- |
+| [build_context](#input_build_context) | string | false | `"."` | Root directory to start the
build from. |
+| [build_dockerfile](#input_build_dockerfile) | string | false | `"Dockerfile"` | Name of dockerfile, relative to
context dir. |
+| [build_target](#input_build_target) | string | false | `"ci"` | The target to built to
(default to ci stage). |
+| [cache_extra_imgs](#input_cache_extra_imgs) | string | false | | Space separated list of images
to cache on each run
(e.g. to avoid rate limiting). |
+| [cache_image](#input_cache_image) | boolean | false | `true` | Cache the built image, for
the next run. Default true. |
+| [compose_command](#input_compose_command) | string | false | | The command to run for
the container. Default to built-in
image command. |
+| [compose_file](#input_compose_file) | string | false | `"docker-compose.yml"` | The docker compose file used
to run the test. |
+| [compose_service](#input_compose_service) | string | true | | The docker compose service to
run the test against. |
+| [coverage](#input_coverage) | boolean | false | `false` | Generate a coverage HTML report
(requires coverage.py installed). |
+| [environment](#input_environment) | string | false | `"test"` | The environment to use for
testing. |
+| [example_env_file_path](#input_example_env_file_path) | string | false | `".env.example"` | Path to example dotenv file
to substitute variables for. |
+| [extra_build_args](#input_extra_build_args) | string | false | | Space separated list of build
args to use for the
image. |
+| [image_name](#input_image_name) | string | false | | The image root name to
build, without tag. E.g. 'ghcr.io/[dollar]{{
github.repository }}' |
+| [playwright](#input_playwright) | boolean | false | `false` | Upload the Playwright trace files
as an artifact for debugging. |
+| [pre_command](#input_pre_command) | string | false | | A initialisation command to run
prior to the docker compose
command. |
+| [tag_override](#input_tag_override) | string | false | | An override for the build
image tag. Must include tests
and have test software installed |