docs: update GitLab links (5bb40fc9) · Commits · to be continuous... / semantic-release

.gitlab/merge_request_templates/new_feature.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -8,8 +8,8 @@ Closes #999
		## Checklist

		* General:
		* [ ] use [rules](https://docs.gitlab.com/ee/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ee/ci/yaml/#onlyexcept-advanced)
		* [ ] optimized [cache](https://docs.gitlab.com/ee/ci/caching/) configuration (wherever applicable)
		* [ ] use [rules](https://docs.gitlab.com/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ci/yaml/#onlyexcept-advanced)
		* [ ] optimized [cache](https://docs.gitlab.com/ci/caching/) configuration (wherever applicable)
		* Publicly usable:
		* [ ] untagged runners
		* [ ] no proxy configuration but support `http_proxy`/`https_proxy`/`no_proxy`

CONTRIBUTING.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -61,7 +61,7 @@ To contribute:

		1. Create an issue describing the bug or enhancement you want to propose (select the right issue template).
		2. Make sure the issue has been reviewed and agreed.
		3. Create a Merge Request, from your own fork (see [forking workflow](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) documentation).
		3. Create a Merge Request, from your own fork (see [forking workflow](https://docs.gitlab.com/user/project/repository/forking_workflow/) documentation).
		Don't hesitate to mark your MR as `Draft` as long as you think it's not ready to be reviewed.

		### Git Commit Conventions

README.md

+13 −13

Original line number	Diff line number	Diff line
		@@ -6,12 +6,12 @@ This project implements a GitLab CI/CD template to automate your versioning and
		* 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),
		* publish the packages (in [GitLab](https://docs.gitlab.com/user/project/releases/) 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

		This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component) or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.
		This template can be used both as a [CI/CD component](https://docs.gitlab.com/ci/components/#use-a-component) or using the legacy [`include:project`](https://docs.gitlab.com/ci/yaml/#includeproject) syntax.

		### Use as a CI/CD component

		@@ -51,9 +51,9 @@ The semantic-release template uses some global configuration used throughout all
		\| `image` / `SEMREL_IMAGE` \| The Docker image used to run semantic-release \| `registry.hub.docker.com/library/node:lts-slim` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-SEMREL_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-SEMREL_IMAGE) \|
		\| `version` / `SEMREL_VERSION` \| The [semantic-release](https://www.npmjs.com/package/semantic-release) version to use \| `latest` \|
		\| `exec-version` / `SEMREL_EXEC_VERSION` \| The [@semantic-release/exec](https://www.npmjs.com/package/@semantic-release/exec) version to use \| `latest` \|
		\| :lock: `GITLAB_TOKEN` \| A GitLab [project access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html) or [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html) with `api`, `read_repository` and `write repository` scopes. :warning: This variable is mandatory and [defined by `semantic-release`](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/ci-configuration.md#push-access-to-the-remote-repository) itself. \| _none_ \|
		\| :lock: `GIT_AUTHOR_EMAIL` \| A Git author email address associated with the `GITLAB_TOKEN` [bot user](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#bot-users-for-projects). This is [defined by `semantic-release`](https://semantic-release.gitbook.io/semantic-release/usage/configuration#git-environment-variables) itself, and required if the [verify-user push rules](https://docs.gitlab.com/ee/user/project/repository/push_rules.html#verify-users) enabled for the project \| _none_ \|
		\| :lock: `GIT_COMMITTER_EMAIL` \| A Git committer email address associated with the `GITLAB_TOKEN` [bot user](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html#bot-users-for-projects). This is [defined by `semantic-release`](https://semantic-release.gitbook.io/semantic-release/usage/configuration#git-environment-variables) itself, and required if the [verify-user push rules](https://docs.gitlab.com/ee/user/project/repository/push_rules.html#verify-users) enabled for the project \| _none_ \|
		\| :lock: `GITLAB_TOKEN` \| A GitLab [project access token](https://docs.gitlab.com/user/project/settings/project_access_tokens/) or [personal access token](https://docs.gitlab.com/user/profile/personal_access_tokens/) with `api`, `read_repository` and `write repository` scopes. :warning: This variable is mandatory and [defined by `semantic-release`](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/ci-configuration.md#push-access-to-the-remote-repository) itself. \| _none_ \|
		\| :lock: `GIT_AUTHOR_EMAIL` \| A Git author email address associated with the `GITLAB_TOKEN` [bot user](https://docs.gitlab.com/user/project/settings/project_access_tokens/#bot-users-for-projects). This is [defined by `semantic-release`](https://semantic-release.gitbook.io/semantic-release/usage/configuration#git-environment-variables) itself, and required if the [verify-user push rules](https://docs.gitlab.com/user/project/repository/push_rules/#verify-users) enabled for the project \| _none_ \|
		\| :lock: `GIT_COMMITTER_EMAIL` \| A Git committer email address associated with the `GITLAB_TOKEN` [bot user](https://docs.gitlab.com/user/project/settings/project_access_tokens/#bot-users-for-projects). This is [defined by `semantic-release`](https://semantic-release.gitbook.io/semantic-release/usage/configuration#git-environment-variables) itself, and required if the [verify-user push rules](https://docs.gitlab.com/user/project/repository/push_rules/#verify-users) enabled for the project \| _none_ \|
		\| `config-dir` / `SEMREL_CONFIG_DIR` \| directory containing your [semantic-release configuration](https://semantic-release.gitbook.io/semantic-release/usage/configuration#configuration-file) \| `.` \|
		\| `required-plugins-file` / `SEMREL_REQUIRED_PLUGINS_FILE` \| An optional file for additional npm packages to install \| `semrel-required-plugins.txt` \|

		@@ -161,17 +161,17 @@ Parameters:

		#### Signing release commits with GPG

		For an introduction on commit signing, see [GitLab documentation](https://docs.gitlab.com/ee/user/project/repository/signed_commits/gpg.html).
		For an introduction on commit signing, see [GitLab documentation](https://docs.gitlab.com/user/project/repository/signed_commits/gpg/).

		To make semantic-release sign its commits, use the following variable.

		\| Input / Variable \| Description \| Default value \|
		\| --------------------------- \| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- \| ------------- \|
		\| :lock: `SEMREL_GPG_SIGNKEY` \| Path to the GPG signkey exported with `gpg --armor --export-secret-key`<br/>:warning: Declare as a masked [project variable of File type](https://docs.gitlab.com/ee/ci/variables/#cicd-variable-types). \| _none_ \|
		\| :lock: `SEMREL_GPG_SIGNKEY` \| Path to the GPG signkey exported with `gpg --armor --export-secret-key`<br/>:warning: Declare as a masked [project variable of File type](https://docs.gitlab.com/ci/variables/#cicd-variable-types). \| _none_ \|

		### `semantic-release-info` job

		This job (disabled by default) runs `semantic-release` with `dry-run` mode in `.pre` stage to save the following variables as [dotenv artifact](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsdotenv) making them available for the next pipeline stages:
		This job (disabled by default) runs `semantic-release` with `dry-run` mode in `.pre` stage to save the following variables as [dotenv artifact](https://docs.gitlab.com/ci/yaml/artifacts_reports/#artifactsreportsdotenv) making them available for the next pipeline stages:

		* `SEMREL_INFO_LAST_VERSION`: latest released version
		* `SEMREL_INFO_NEXT_VERSION`: next release version (based on actual commits and comments)
		@@ -213,12 +213,12 @@ If the version of Semantic Release is pinned using [`SEMREL_VERSION`](#global-co

		Here are some advices about your secrets (variables marked with a :lock:):

		1. Manage them as [project or group CI/CD variables](https://docs.gitlab.com/ee/ci/variables/#for-a-project):
		* [masked](https://docs.gitlab.com/ee/ci/variables/#mask-a-cicd-variable) to prevent them from being inadvertently
		1. Manage them as [project or group CI/CD variables](https://docs.gitlab.com/ci/variables/#for-a-project):
		* [masked](https://docs.gitlab.com/ci/variables/#mask-a-cicd-variable) to prevent them from being inadvertently
		displayed in your job logs,
		* [protected](https://docs.gitlab.com/ee/ci/variables/#protected-cicd-variables) if you want to secure some secrets
		* [protected](https://docs.gitlab.com/ci/variables/#protected-cicd-variables) if you want to secure some secrets
		you don't want everyone in the project to have access to (for instance production secrets).
		2. In case a secret contains [characters that prevent it from being masked](https://docs.gitlab.com/ee/ci/variables/#mask-a-cicd-variable),
		2. In case a secret contains [characters that prevent it from being masked](https://docs.gitlab.com/ci/variables/#mask-a-cicd-variable),
		simply define its value as the [Base64](https://en.wikipedia.org/wiki/Base64) encoded value prefixed with `@b64@`:
		it will then be possible to mask it and the template will automatically decode it prior to using it.
		3. Don't forget to escape special characters (ex: `$` -> `$$`).
		@@ -360,7 +360,7 @@ In order to be able to communicate with the Vault server, the variant requires t
		\| :lock: `VAULT_ROLE_ID` \| The [AppRole](https://www.vaultproject.io/docs/auth/approle) RoleID \| _none_ \|
		\| :lock: `VAULT_SECRET_ID` \| The [AppRole](https://www.vaultproject.io/docs/auth/approle) SecretID \| _none_ \|

		By default, the variant will authentifacte using a [JWT ID token](https://docs.gitlab.com/ee/ci/secrets/id_token_authentication.html). To use [AppRole](https://www.vaultproject.io/docs/auth/approle) instead the `VAULT_ROLE_ID` and `VAULT_SECRET_ID` should be defined as secret project variables.
		By default, the variant will authentifacte using a [JWT ID token](https://docs.gitlab.com/ci/secrets/id_token_authentication/). To use [AppRole](https://www.vaultproject.io/docs/auth/approle) instead the `VAULT_ROLE_ID` and `VAULT_SECRET_ID` should be defined as secret project variables.

		#### Usage