
smartdatalab/public/ci-cd-components/semantic-release
Semantic Release
3.14.2
Forked from https://gitlab.com/to-be-continuous/semantic-release/ at 20240510.
Find usage examples at: https://git.code.tecnalia.com/smartdatalab/libraries/ci-cd-samples
gitlab-ci-semrel
include:
- component: $CI_SERVER_FQDN/smartdatalab/public/ci-cd-components/semantic-release/gitlab-ci-semrel@3.14.2
Name | Mandatory | Type | Description | Default |
---|---|---|---|---|
image | false | string | The Docker image used to run semantic-release | registry.hub.docker.com/library/node:lts-slim |
dry-run | false | boolean | For generated `.releaserc` file only. Activate the [dryRun semantic-release option](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#dryrun) if present. | |
info-on | false | string | Define on which branch(es) the job shall be run | |
version | false | string | The [semantic-release](https://www.npmjs.com/package/semantic-release) version to use | latest |
hooks-dir | false | string | Hook scripts folder. | . |
config-dir | false | string | directory containing your [semantic-release configuration](https://semantic-release.gitbook.io/semantic-release/usage/configuration#configuration-file) | . |
extra-args | false | string | [Extra options](https://semantic-release.gitbook.io/semantic-release/usage/configuration#options) to pass to semantic-release. | |
git-plugin | false | string | The npm plugin name for the git plugin. The default is `@semantic-release/git` | @semantic-release/git |
tag-format | false | string | For generated `.releaserc` file only. [tagFormat semantic-release option](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#tagformat)e. :warning: don't forget to double the `$` character so it is not interpreted by GitLab. | $${version} |
commit-spec | false | string | Commit specification `preset` (possible values: `angular`, `codemirror`, `ember`, `eslint`, `express`, `jquery`, `jshint`, `conventionalcommits`). The default is `angular`. | angular |
exec-plugin | false | string | The npm plugin name for the exec plugin. The default is `@semantic-release/exec` | @semantic-release/exec |
branches-ref | false | string | Regular expression pattern matching branches from which releases should happen (should match your [semantic-release configuration](https://semantic-release.gitbook.io/semantic-release/usage/configuration#branches)) | /^(master|main)$/ |
exec-version | false | string | The [@semantic-release/exec](https://www.npmjs.com/package/@semantic-release/exec) version to use | latest |
gitlab-plugin | false | string | The npm plugin name for the gitlab plugin. The default is `@semantic-release/gitlab` | @semantic-release/gitlab |
changelog-file | false | string | [changelogFile @semantic-release/changelog option](https://github.com/semantic-release/changelog#options). | CHANGELOG.md |
commit-message | false | string | [message @semantic-release/git option](https://github.com/semantic-release/git#message) | |
changelog-title | false | string | [changelogTitle @semantic-release/changelog option](https://github.com/semantic-release/changelog#options). You might want to use markdown format (for example `# MyApp Changelog`). | |
changelog-plugin | false | string | The npm plugin name for the changelog plugin. The default is `@semantic-release/changelog` | @semantic-release/changelog |
release-disabled | false | boolean | Disable semantic-release | |
changelog-enabled | false | boolean | Add the [@semantic-release/changelog](https://github.com/semantic-release/changelog) plugin which will commit a changelog file in the repository. | |
auto-release-enabled | false | boolean | When set the job start automatically. When not set (default), the job is manual. | |
required-plugins-file | false | string | Full path to `semrel-required-plugins.txt` file _(relative to `$CI_PROJECT_DIR`)_ | semrel-required-plugins.txt |
commit-analyzer-plugin | false | string | The npm plugin name for the commit-analyzer plugin. The default is `@semantic-release/commit-analyzer` | @semantic-release/commit-analyzer |
semantic-release-job-tags | false | array | Tags to be used for selecting runners for the job | [] |
release-notes-generator-plugin | false | string | The npm plugin name for the release-notes-generator plugin. The default is `@semantic-release/release-notes-generator` | @semantic-release/release-notes-generator |
gitlab-ci-semrel-vault
include:
- component: $CI_SERVER_FQDN/smartdatalab/public/ci-cd-components/semantic-release/gitlab-ci-semrel-vault@3.14.2