Commit 415b1ea1 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

Merge branch '20-detail-in-the-introduction-the-features-offered-by-this-template' into 'master' 

Resolve "Detail in the introduction the features offered by this template"

Closes #20

See merge request to-be-continuous/semantic-release!27
parents c15b35b6 87875006

README.md

+10 −0
Original line number Diff line number Diff line
@@ -4,6 +4,16 @@ This project implements a generic GitLab CI template for [semantic-release](http 


It provides several features, usable in different modes (by configuration).



This template makes use of [semantic-release](https://semantic-release.gitbook.io/) to **automate your release process** 

from your pipeline, supporting one or several of the following features:



* determine the next release version number,

* generate the changelog,

* commit any changed resource to the Git repository,

* create and push the Git tag,

* publish the packages (in [GitLab](https://docs.gitlab.com/ee/user/project/releases/index.html) or any other package repository of your choice),

* any additional custom behavior you are able to script, triggered on the [release steps](https://semantic-release.gitbook.io/semantic-release/#release-steps).



## Usage



In order to include this template in your project, add the following to your `gitlab-ci.yml`: