From 1c72cdf92df0220fb57628f259e3f9bb80cc1d18 Mon Sep 17 00:00:00 2001
From: Timo Furrer <tfurrer@gitlab.com>
Date: Thu, 31 Oct 2024 19:38:29 +0100
Subject: [PATCH] Add example repositories section to README

Changelog: added
---
 .gitlab/README.md.template | 12 ++++++++++++
 README.md                  | 12 ++++++++++++
 2 files changed, 24 insertions(+)

diff --git a/.gitlab/README.md.template b/.gitlab/README.md.template
index e28b928..d5e7efc 100644
--- a/.gitlab/README.md.template
+++ b/.gitlab/README.md.template
@@ -286,6 +286,14 @@ or `TF_CLI_ARGS_init` (handled by OpenTofu directly) to `-lockfile=readonly`
 to prevent any changes to the lockfile during the pipeline job and with
 that ensuring that OpenTofu really uses the locked dependencies.
 
+### Examples
+
+Here are some example repositories to demonstrate how this component maybe used:
+
+- [timofurrer/opentofu-test](https://gitlab.com/timofurrer/opentofu-test): uses multiple environments configured for different kinds of pipelines with a single branch.
+
+Please contribute your own examples!
+
 ## Releases & Versioning
 
 This project currently releases tagged commits.
@@ -416,6 +424,10 @@ Some more example configurations for your `renovate.json`:
   },
   ```
 
+**Example Repositories**:
+
+- [timofurrer/opentofu-test](https://gitlab.com/timofurrer/opentofu-test)
+
 ## Usage on self-managed
 
 GitLab CI/CD components are not yet distributed and available on self-managed GitLab instances.
diff --git a/README.md b/README.md
index b4477fb..9bfdff9 100644
--- a/README.md
+++ b/README.md
@@ -305,6 +305,14 @@ or `TF_CLI_ARGS_init` (handled by OpenTofu directly) to `-lockfile=readonly`
 to prevent any changes to the lockfile during the pipeline job and with
 that ensuring that OpenTofu really uses the locked dependencies.
 
+### Examples
+
+Here are some example repositories to demonstrate how this component maybe used:
+
+- [timofurrer/opentofu-test](https://gitlab.com/timofurrer/opentofu-test): uses multiple environments configured for different kinds of pipelines with a single branch.
+
+Please contribute your own examples!
+
 ## Releases & Versioning
 
 This project currently releases tagged commits.
@@ -435,6 +443,10 @@ Some more example configurations for your `renovate.json`:
   },
   ```
 
+**Example Repositories**:
+
+- [timofurrer/opentofu-test](https://gitlab.com/timofurrer/opentofu-test)
+
 ## Usage on self-managed
 
 GitLab CI/CD components are not yet distributed and available on self-managed GitLab instances.
-- 
GitLab