From 1deda55c7f4a12b69b439af0f6d2eec4e9b97783 Mon Sep 17 00:00:00 2001
From: Timo Furrer <tfurrer@gitlab.com>
Date: Thu, 10 Oct 2024 06:23:14 +0200
Subject: [PATCH] Improve documentation around module release
Changelog: changed
---
.gitlab/README.md.template | 19 ++++++++++---------
README.md | 19 ++++++++++---------
2 files changed, 20 insertions(+), 18 deletions(-)
diff --git a/.gitlab/README.md.template b/.gitlab/README.md.template
index ae15619..e7008ec 100644
--- a/.gitlab/README.md.template
+++ b/.gitlab/README.md.template
@@ -190,18 +190,19 @@ plan:
- TF_ROOT: prod/
```
-Have a look at the [`full-pipeline`](templates/full-pipeline.yml) for how it's constructed.
+Have a look at the [`full-pipeline`](templates/job-templates.yml) for how it's constructed.
The following job components exist:
-- [`fmt`](templates/fmt.yml)
-- [`validate`](templates/validate.yml)
-- [`test`](templates/test.yml)
-- [`plan`](templates/plan.yml)
-- [`apply`](templates/apply.yml)
-- [`destroy`](templates/destroy.yml)
-- [`delete-state`](templates/delete-state.yml)
-- [`custom-command`](templates/custom-command.yml)
+- [`fmt`](templates/fmt.yml): Check formatting of configuration files.
+- [`validate`](templates/validate.yml): Validate configuration.
+- [`test`](templates/test.yml): Test configuration.
+- [`plan`](templates/plan.yml): Plan an apply or destroy.
+- [`apply`](templates/apply.yml): Apply a configuration.
+- [`destroy`](templates/destroy.yml): Destroy a configuration.
+- [`delete-state`](templates/delete-state.yml): Delete the GitLab-managed Terraform state.
+- [`custom-command`](templates/custom-command.yml): Run a custom OpenTofu command.
+- [`module-release`](templates/module-release.yml): Release an OpenTofu module to the GitLab Terraform Module Registry.
Have a look at the individual template spec to learn about the available inputs.
diff --git a/README.md b/README.md
index dcb0f22..9314f70 100644
--- a/README.md
+++ b/README.md
@@ -192,18 +192,19 @@ plan:
- TF_ROOT: prod/
```
-Have a look at the [`full-pipeline`](templates/full-pipeline.yml) for how it's constructed.
+Have a look at the [`full-pipeline`](templates/job-templates.yml) for how it's constructed.
The following job components exist:
-- [`fmt`](templates/fmt.yml)
-- [`validate`](templates/validate.yml)
-- [`test`](templates/test.yml)
-- [`plan`](templates/plan.yml)
-- [`apply`](templates/apply.yml)
-- [`destroy`](templates/destroy.yml)
-- [`delete-state`](templates/delete-state.yml)
-- [`custom-command`](templates/custom-command.yml)
+- [`fmt`](templates/fmt.yml): Check formatting of configuration files.
+- [`validate`](templates/validate.yml): Validate configuration.
+- [`test`](templates/test.yml): Test configuration.
+- [`plan`](templates/plan.yml): Plan an apply or destroy.
+- [`apply`](templates/apply.yml): Apply a configuration.
+- [`destroy`](templates/destroy.yml): Destroy a configuration.
+- [`delete-state`](templates/delete-state.yml): Delete the GitLab-managed Terraform state.
+- [`custom-command`](templates/custom-command.yml): Run a custom OpenTofu command.
+- [`module-release`](templates/module-release.yml): Release an OpenTofu module to the GitLab Terraform Module Registry.
Have a look at the individual template spec to learn about the available inputs.
--
GitLab