README.md

Release By Changelog

Objective

Publish a new release based on the content of the CHANGELOG.md file. The file must follow the Keep a Changelog format and each release must adhere to Semantic Versioning.

How to use it

Include the component/template

Add the following to your .gitlab-ci.yml file.

As a remote Template (recommended):

include:
    -   remote: 'https://gitlab.com/swepy/cicd-templates/release-by-changelog/-/raw/0.4.4/templates/release-by-changelog.yml'

As a local Template (if the template is local to the instance):

include:
    -   project: 'swepy/cicd-templates/release-by-changelog'
        ref: '0.4.4'
        file: 'templates/release-by-changelog.yml'

As a Component (beta and if the component is local to the instance):

include:
    -   component: $CI_SERVER_FQDN/swepy/cicd-templates/release-by-changelog/release-by-changelog@0.4.4

Customize job

You can customize the job by overriding specific keys. For example:

release-by-changelog:
    stage: release
    variables:
        CHANGELOG_FILEPATH: "docs/CHANGELOG.md"

Variables

You can customize the job by overriding the following variables: