From 878ab6e47f68662ebb6f491d4dede8fe88e6d795 Mon Sep 17 00:00:00 2001
From: Dorian Turba <froggit.commit.z3jqj@simplelogin.com>
Date: Sun, 12 May 2024 23:33:15 +0200
Subject: [PATCH] add doc about include remote
---
CHANGELOG.md | 2 ++
README.md | 13 ++++++++++---
2 files changed, 12 insertions(+), 3 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index aeddd5f..2f1513a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
+* More documentation
+
## [0.4.0] - 2024-05-12
* More documentation
diff --git a/README.md b/README.md
index 890d58d..4828af7 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,14 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Add the following to your `.gitlab-ci.yml` file.
-As a Template:
+As a remote Template (recommended):
+
+```yaml
+include:
+ - remote: 'https://gitlab.com/swepy/cicd-templates/release-by-changelog/-/raw/release-by-changelog@0.4.0/release-by-changelog.yml'
+```
+
+As a local Template (if the template is local to the instance):
```yaml
include:
@@ -24,10 +31,10 @@ include:
file: 'templates/release-by-changelog.yml'
```
-As a Component:
+As a Component ([beta](https://gitlab.com/gitlab-org/gitlab/-/issues/407556) and if the
+component is local to the instance):
```yaml
-# As a Component
include:
- component: $CI_SERVER_FQDN/swepy/cicd-templates/release-by-changelog/release-by-changelog@0.4.0
```
--
GitLab