Skip to content
Snippets Groups Projects
Unverified Commit 47f17af2 authored by Timo Furrer's avatar Timo Furrer
Browse files

Document inputs options

parent 23ebead6
No related branches found
No related tags found
No related merge requests found
docs: docs:
csplit -sf readme -n 1 .gitlab/README.md '/<INPUTS>/' csplit -sf readme -n 1 .gitlab/README.md '/<INPUTS>/'
yq '.spec.inputs | .[] | "| `" + key + "` | `" + .default + "` | " + .description + " |"' templates/full-pipeline.yml > readme_inputs.md yq '.spec.inputs | .[] | "| `" + key + "` | `" + .default + "` | " + .description + (.options | (" Must be one of " + (. | map("`" + . + "`")| join(", ") + "." )) // "") + " |"' templates/full-pipeline.yml > readme_inputs.md
echo '<!-- This document is generated by `make docs` from `.gitlab/README.md` -->' > README.md echo '<!-- This document is generated by `make docs` from `.gitlab/README.md` -->' > README.md
echo >> README.md echo >> README.md
cat readme0 >> README.md cat readme0 >> README.md
......
...@@ -76,7 +76,7 @@ stages: [validate, test, build, deploy, cleanup] ...@@ -76,7 +76,7 @@ stages: [validate, test, build, deploy, cleanup]
| `stage_deploy` | `deploy` | Defines the deploy stage. This stage includes the `apply` job. | | `stage_deploy` | `deploy` | Defines the deploy stage. This stage includes the `apply` job. |
| `stage_cleanup` | `cleanup` | Defines the cleanup stage. This stage includes the `destroy` and `delete-state` jobs. | | `stage_cleanup` | `cleanup` | Defines the cleanup stage. This stage includes the `destroy` and `delete-state` jobs. |
| `version` | `latest` | Version of this component. Has to be the same as the one in the component include entry. | | `version` | `latest` | Version of this component. Has to be the same as the one in the component include entry. |
| `opentofu_version` | `1.6.0` | OpenTofu version that should be used. | | `opentofu_version` | `1.6.0` | OpenTofu version that should be used. Must be one of `1.6.0`, `1.6.0-rc1`. |
| `gitlab_opentofu_image` | `$CI_REGISTRY/components/opentofu/gitlab-opentofu:$[[ inputs.version ]]-opentofu$[[ inputs.opentofu_version ]]` | Tag of the gitlab-opentofu image. | | `gitlab_opentofu_image` | `$CI_REGISTRY/components/opentofu/gitlab-opentofu:$[[ inputs.version ]]-opentofu$[[ inputs.opentofu_version ]]` | Tag of the gitlab-opentofu image. |
| `root_dir` | `${CI_PROJECT_DIR}` | Root directory for the OpenTofu project. | | `root_dir` | `${CI_PROJECT_DIR}` | Root directory for the OpenTofu project. |
| `state_name` | `default` | Remote OpenTofu state name. | | `state_name` | `default` | Remote OpenTofu state name. |
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment