diff --git a/docs/doxygen_build.md b/docs/doxygen_build.md index 6d2073b..8c728b3 100644 --- a/docs/doxygen_build.md +++ b/docs/doxygen_build.md @@ -8,9 +8,9 @@ It needs a Doxyfile present under `docs/Doxyfile`. -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -| ----------------------------------------------------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------- | -| [output_path](#input_output_path) | string | false | | If specified, the output dir
is uploaded to artifact extra-docs-files. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------------------------------------------------------- | ------ | -------- | ------- | -------------------------------------------------------------- | +| [output_path](#input_output_path) | string | false | | If specified, the output dir
is uploaded named `artifact`. | @@ -18,7 +18,9 @@ It needs a Doxyfile present under `docs/Doxyfile`. -No outputs. +| OUTPUT | VALUE | DESCRIPTION | +| ------------------------------------------------------------------------- | ----------- | ---------------------------------------- | +| [artifact_name](#output_artifact_name) | `"doxygen"` | The artifact name (default: `artifact`). | diff --git a/docs/image_artifact.md b/docs/image_artifact.md index 8127752..766bc87 100644 --- a/docs/image_artifact.md +++ b/docs/image_artifact.md @@ -19,10 +19,9 @@ registries where rate limiting is applied (e.g. dockerhub). -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -| ----------------------------------------------------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- | -| [artifact_name](#input_artifact_name) | string | true | | The artifact name to use,
e.g. images. | -| [image_names](#input_image_names) | string | true | | A space separated list of
full image names to upload,
including tag. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------------------------------------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- | +| [image_names](#input_image_names) | string | true | | A space separated list of
full image names to upload,
including tag. | @@ -30,9 +29,9 @@ registries where rate limiting is applied (e.g. dockerhub). -| OUTPUT | VALUE | DESCRIPTION | -| ------------------------------------------------------------------------- | ------------------------------- | ---------------------------------------- | -| [artifact_name](#output_artifact_name) | `"${{ inputs.artifact_name }}"` | The artifact name used during
input. | +| OUTPUT | VALUE | DESCRIPTION | +| ------------------------------------------------------------------------- | ---------- | ---------------------------------------- | +| [artifact_name](#output_artifact_name) | `"images"` | The artifact name (default: `artifact`). | diff --git a/docs/mkdocs_build.md b/docs/mkdocs_build.md index 2e279c9..be0f372 100644 --- a/docs/mkdocs_build.md +++ b/docs/mkdocs_build.md @@ -11,13 +11,13 @@ You need to have: -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -| -------------------------------------------------------------------------------- | ------- | -------- | ------------------------------------------- | ----------------------------------------------------------------------------- | -| [doxygen](#input_doxygen) | string | false | | Include doxygen output uploaded to
extra-docs-files artifact. | -| [image](#input_image) | string | false | `"ghcr.io/hotosm/gh-workflows/mkdocs:main"` | Override the image to build
mkdocs. | -| [keep_extra_files](#input_keep_extra_files) | boolean | false | `false` | Only update modified files. Default
false, to clean repo before
push. | -| [openapi](#input_openapi) | string | false | | Include openapi output uploaded to
extra-docs-files artifact. | -| [stories](#input_stories) | string | false | | Include story build output uploaded
to extra-docs-files artifact. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------------------------------------------------------------------------- | ------- | -------- | ------------------------------------------- | ----------------------------------------------------------------------------- | +| [doxygen](#input_doxygen) | string | false | | Include doxygen output uploaded to
`artifact` key. | +| [image](#input_image) | string | false | `"ghcr.io/hotosm/gh-workflows/mkdocs:main"` | Override the image to build
mkdocs. | +| [include_artifacts](#input_include_artifacts) | string | false | | Include all uploaded artifacts from
the workflow. | +| [keep_extra_files](#input_keep_extra_files) | boolean | false | `false` | Only update modified files. Default
false, to clean repo before
push. | +| [openapi](#input_openapi) | string | false | | Include openapi output uploaded to
`artifact` key. | diff --git a/docs/openapi_build.md b/docs/openapi_build.md index bbab4e8..62ec0ed 100644 --- a/docs/openapi_build.md +++ b/docs/openapi_build.md @@ -10,7 +10,7 @@ Build OpenAPI YAML for use in Swagger or ReDoc documentation sites. | ----------------------------------------------------------------------------------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------- | | [example_env_file_path](#input_example_env_file_path) | string | true | | FastAPI must start with an
environment set. Path to a
.env with dummy vars. | | [image](#input_image) | string | true | | The image to build to
OpenAPI JSON (dependencies included, i.e. FastAPI.). | -| [output_path](#input_output_path) | string | false | | If specified, the output dir
is uploaded to artifact extra-docs-files. | +| [output_path](#input_output_path) | string | false | | If specified, the output dir
is uploaded to the `artifact`
key. | diff --git a/docs/pnpm_build.md b/docs/pnpm_build.md index 60f54f5..d6d0b9a 100644 --- a/docs/pnpm_build.md +++ b/docs/pnpm_build.md @@ -9,11 +9,12 @@ npm command that builds the stories dist. -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -| ----------------------------------------------------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------- | -| [command](#input_command) | string | true | | The pnpm command to run
in package.json. | -| [output_path](#input_output_path) | string | false | | If specified, the output dir
is uploaded to artifact extra-docs-files. | -| [working_dir](#input_working_dir) | string | false | `"."` | The directory containing the package.json
file. | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| -------------------------------------------------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------- | +| [command](#input_command) | string | true | | The pnpm command to run
in package.json. | +| [github_pages](#input_github_pages) | boolean | false | `false` | Upload in format specific for
Github Pages `actions/deploy-pages`. | +| [output_path](#input_output_path) | string | false | | The output path is uploaded
to a key named `artifact`. | +| [working_dir](#input_working_dir) | string | false | `"."` | The directory containing the package.json
file. | @@ -21,7 +22,9 @@ npm command that builds the stories dist. -No outputs. +| OUTPUT | VALUE | DESCRIPTION | +| ------------------------------------------------------------------------- | --------- | ---------------------------------------- | +| [artifact_name](#output_artifact_name) | `"build"` | The artifact name (default: `artifact`). | diff --git a/docs/test_compose.md b/docs/test_compose.md index a5e8c08..69bf9fd 100644 --- a/docs/test_compose.md +++ b/docs/test_compose.md @@ -155,7 +155,7 @@ services: | [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 | true | | The command to run within
the docker compose service. | +| [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). |