Improve input docs

README.md

@@ -71,18 +71,17 @@ stages: [validate, test, build, deploy, cleanup]
 
 | Name | Default | Description |
 | ---- | ------- | ----------- |
-| `stage_validate` | `validate` | Defines the validate stage |
-| `stage_test` | `test` | Defines the test stage |
-| `stage_build` | `build` | Defines the build stage |
-| `stage_deploy` | `deploy` | Defines the deploy stage |
-| `stage_cleanup` | `cleanup` | Defines the cleanup stage |
-| `version` | `latest` | Version of this component |
-| `opentofu_version` | `1.6.0` | Released version of upstream OpenTofu |
-| `gitlab_opentofu_image` | `$CI_REGISTRY/components/opentofu/gitlab-opentofu:$[[ inputs.version ]]-opentofu$[[ inputs.opentofu_version ]]` | Image name of the gitlab-opentofu image |
-| `root_dir` | `${CI_PROJECT_DIR}` | Root directory for the OpenTofu project |
-| `state_name` | `default` | State name |
-| `auto_apply` | `false` | Whether the apply job is manual or automatically run |
-| `auto_destroy` | `false` | Whether the destroy job is manual or automatically run |
+| `stage_validate` | `validate` | Defines the validate stage. This stage includes the `fmt` and `validate` jobs. |
+| `stage_build` | `build` | Defines the build stage. This stage includes the `plan` 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. |
+| `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. |
+| `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. |
+| `state_name` | `default` | Remote OpenTofu state name. |
+| `auto_apply` | `false` | Whether the apply job is manual or automatically run. |
+| `auto_destroy` | `false` | Whether the destroy job is manual or automatically run. |
 
 ## Releases & Versioning
 

templates/full-pipeline.yml

@@ -3,33 +3,30 @@ spec:
     # Stages
     stage_validate:
       default: 'validate'
-      description: 'Defines the validate stage'  
-    stage_test:
-      default: 'test'
-      description: 'Defines the test stage'
+      description: 'Defines the validate stage. This stage includes the `fmt` and `validate` jobs.'  
     stage_build:
       default: 'build'
-      description: 'Defines the build stage'
+      description: 'Defines the build stage. This stage includes the `plan` job.'
     stage_deploy:
       default: 'deploy'
-      description: 'Defines the deploy stage'
+      description: 'Defines the deploy stage. This stage includes the `apply` job.'
     stage_cleanup:
       default: 'cleanup'
-      description: 'Defines the cleanup stage'
+      description: 'Defines the cleanup stage. This stage includes the `destroy` and `delete-state` jobs.'
 
     # Versions
     # This version is only required, because we cannot access the context of the component,
     # see https://gitlab.com/gitlab-org/gitlab/-/issues/438275
     version:
       default: 'latest'
-      description: 'Version of this component'
+      description: 'Version of this component. Has to be the same as the one in the component include entry.'
       
     opentofu_version:
       default: '1.6.0'
       options:
         - '1.6.0'
         - '1.6.0-rc1'
-      description: 'Released version of upstream OpenTofu'
+      description: 'OpenTofu version that should be used.'
 
     # Images
     gitlab_opentofu_image:
@@ -37,21 +34,21 @@ spec:
       #        Currently, blocked by https://gitlab.com/gitlab-org/gitlab/-/issues/438275
       # default: '$CI_REGISTRY/components/opentofu/gitlab-opentofu:$[[ inputs.opentofu_version ]]'
       default: '$CI_REGISTRY/components/opentofu/gitlab-opentofu:$[[ inputs.version ]]-opentofu$[[ inputs.opentofu_version ]]'
-      description: 'Image name of the gitlab-opentofu image'
+      description: 'Tag of the gitlab-opentofu image.'
     
     # Configuration
     root_dir: 
       default: ${CI_PROJECT_DIR}
-      description: 'Root directory for the OpenTofu project'
+      description: 'Root directory for the OpenTofu project.'
     state_name:
       default: default
-      description: 'State name'
+      description: 'Remote OpenTofu state name.'
     auto_apply:
       default: 'false'
-      description: 'Whether the apply job is manual or automatically run'
+      description: 'Whether the apply job is manual or automatically run.'
     auto_destroy:
       default: 'false'
-      description: 'Whether the destroy job is manual or automatically run'
+      description: 'Whether the destroy job is manual or automatically run.'
 
 ---