diff --git a/CHANGELOG.md b/CHANGELOG.md index aeddd5fd6f8c7f91293da0b64bf0b4b6ebb785e9..2f1513a9e74bee362f59c9b37087f3ca932fb4eb 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 890d58d4fa539aad352c7df402ca4896205502a7..4828af74196cc84b16301ded142f7fb32e3b5007 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 ```