Skip to content

Commit

Permalink
Merge pull request #55 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 Jul 27, 2024
2 parents b87087c + c97e86a commit 7f64fa2
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 26 deletions.
10 changes: 6 additions & 4 deletions docs/doxygen_build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,19 @@ It needs a Doxyfile present under `docs/Doxyfile`.

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

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------- |
| <a name="input_output_path"></a>[output_path](#input_output_path) | string | false | | If specified, the output dir <br>is uploaded to artifact extra-docs-files. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------- | ------ | -------- | ------- | -------------------------------------------------------------- |
| <a name="input_output_path"></a>[output_path](#input_output_path) | string | false | | If specified, the output dir <br>is uploaded named `artifact`. |

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

## Outputs

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

No outputs.
| OUTPUT | VALUE | DESCRIPTION |
| ------------------------------------------------------------------------- | ----------- | ---------------------------------------- |
| <a name="output_artifact_name"></a>[artifact_name](#output_artifact_name) | `"doxygen"` | The artifact name (default: `artifact`). |

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

Expand Down
13 changes: 6 additions & 7 deletions docs/image_artifact.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,19 @@ registries where rate limiting is applied (e.g. dockerhub).

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

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- |
| <a name="input_artifact_name"></a>[artifact_name](#input_artifact_name) | string | true | | The artifact name to use, <br>e.g. images. |
| <a name="input_image_names"></a>[image_names](#input_image_names) | string | true | | A space separated list of <br>full image names to upload, <br>including tag. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------- |
| <a name="input_image_names"></a>[image_names](#input_image_names) | string | true | | A space separated list of <br>full image names to upload, <br>including tag. |

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

## Outputs

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

| OUTPUT | VALUE | DESCRIPTION |
| ------------------------------------------------------------------------- | ------------------------------- | ---------------------------------------- |
| <a name="output_artifact_name"></a>[artifact_name](#output_artifact_name) | `"${{ inputs.artifact_name }}"` | The artifact name used during <br>input. |
| OUTPUT | VALUE | DESCRIPTION |
| ------------------------------------------------------------------------- | ---------- | ---------------------------------------- |
| <a name="output_artifact_name"></a>[artifact_name](#output_artifact_name) | `"images"` | The artifact name (default: `artifact`). |

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

Expand Down
14 changes: 7 additions & 7 deletions docs/mkdocs_build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ You need to have:

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

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| -------------------------------------------------------------------------------- | ------- | -------- | ------------------------------------------- | ----------------------------------------------------------------------------- |
| <a name="input_doxygen"></a>[doxygen](#input_doxygen) | string | false | | Include doxygen output uploaded to <br>extra-docs-files artifact. |
| <a name="input_image"></a>[image](#input_image) | string | false | `"ghcr.io/hotosm/gh-workflows/mkdocs:main"` | Override the image to build <br>mkdocs. |
| <a name="input_keep_extra_files"></a>[keep_extra_files](#input_keep_extra_files) | boolean | false | `false` | Only update modified files. Default <br>false, to clean repo before <br>push. |
| <a name="input_openapi"></a>[openapi](#input_openapi) | string | false | | Include openapi output uploaded to <br>extra-docs-files artifact. |
| <a name="input_stories"></a>[stories](#input_stories) | string | false | | Include story build output uploaded <br>to extra-docs-files artifact. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------------------------- | ------- | -------- | ------------------------------------------- | ----------------------------------------------------------------------------- |
| <a name="input_doxygen"></a>[doxygen](#input_doxygen) | string | false | | Include doxygen output uploaded to <br>`artifact` key. |
| <a name="input_image"></a>[image](#input_image) | string | false | `"ghcr.io/hotosm/gh-workflows/mkdocs:main"` | Override the image to build <br>mkdocs. |
| <a name="input_include_artifacts"></a>[include_artifacts](#input_include_artifacts) | string | false | | Include all uploaded artifacts from <br>the workflow. |
| <a name="input_keep_extra_files"></a>[keep_extra_files](#input_keep_extra_files) | boolean | false | `false` | Only update modified files. Default <br>false, to clean repo before <br>push. |
| <a name="input_openapi"></a>[openapi](#input_openapi) | string | false | | Include openapi output uploaded to <br>`artifact` key. |

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

Expand Down
2 changes: 1 addition & 1 deletion docs/openapi_build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Build OpenAPI YAML for use in Swagger or ReDoc documentation sites.
| ----------------------------------------------------------------------------------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------- |
| <a name="input_example_env_file_path"></a>[example_env_file_path](#input_example_env_file_path) | string | true | | FastAPI must start with an <br>environment set. Path to a <br>.env with dummy vars. |
| <a name="input_image"></a>[image](#input_image) | string | true | | The image to build to <br>OpenAPI JSON (dependencies included, i.e. FastAPI.). |
| <a name="input_output_path"></a>[output_path](#input_output_path) | string | false | | If specified, the output dir <br>is uploaded to artifact extra-docs-files. |
| <a name="input_output_path"></a>[output_path](#input_output_path) | string | false | | If specified, the output dir <br>is uploaded to the `artifact` <br>key. |

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

Expand Down
15 changes: 9 additions & 6 deletions docs/pnpm_build.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,22 @@ npm command that builds the stories dist.

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

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| ----------------------------------------------------------------- | ------ | -------- | ------- | -------------------------------------------------------------------------- |
| <a name="input_command"></a>[command](#input_command) | string | true | | The pnpm command to run <br>in package.json. |
| <a name="input_output_path"></a>[output_path](#input_output_path) | string | false | | If specified, the output dir <br>is uploaded to artifact extra-docs-files. |
| <a name="input_working_dir"></a>[working_dir](#input_working_dir) | string | false | `"."` | The directory containing the package.json <br>file. |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
| -------------------------------------------------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------- |
| <a name="input_command"></a>[command](#input_command) | string | true | | The pnpm command to run <br>in package.json. |
| <a name="input_github_pages"></a>[github_pages](#input_github_pages) | boolean | false | `false` | Upload in format specific for <br>Github Pages `actions/deploy-pages`. |
| <a name="input_output_path"></a>[output_path](#input_output_path) | string | false | | The output path is uploaded <br>to a key named `artifact`. |
| <a name="input_working_dir"></a>[working_dir](#input_working_dir) | string | false | `"."` | The directory containing the package.json <br>file. |

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

## Outputs

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

No outputs.
| OUTPUT | VALUE | DESCRIPTION |
| ------------------------------------------------------------------------- | --------- | ---------------------------------------- |
| <a name="output_artifact_name"></a>[artifact_name](#output_artifact_name) | `"build"` | The artifact name (default: `artifact`). |

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

Expand Down
2 changes: 1 addition & 1 deletion docs/test_compose.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ services:
| <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 | true | | The command to run within <br>the docker compose service. |
| <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). |
Expand Down

0 comments on commit 7f64fa2

Please sign in to comment.