semantic-release
AboutGitHubNeed Help?
Search…
master
README
Usage
Getting started
Installation
CI Configuration
Configuration
Plugins
Workflow configuration
Shareable configurations
Extending
Plugins
Shareable configuration
Recipes
CI configurations
Git hosted services
Release Workflow
Developer guide
JavaScript API
Plugin development
Shareable configuration development
Support
Resources
Frequently Asked Questions
Troubleshooting
Node version requirement
Node Support Policy
Git version requirement
Powered By GitBook
CI Configuration

Run semantic-release only after all tests succeeded

The semantic-release command must be executed only after all the tests in the CI build pass. If the build runs multiple jobs (for example to test on multiple Operating Systems or Node versions) the CI has to be configured to guarantee that the semantic-release command is executed only after all jobs are successful. Here is a few example of the CI services that can be used to achieve this:
See CI configuration recipes for more details.

Authentication

Push access to the remote repository

semantic-release requires push access to the project Git repository in order to create Git tags. The Git authentication can be set with one of the following environment variables:
Variable
Description
GH_TOKEN or GITHUB_TOKEN
GL_TOKEN or GITLAB_TOKEN
BB_TOKEN or BITBUCKET_TOKEN
BB_TOKEN_BASIC_AUTH or BITBUCKET_TOKEN_BASIC_AUTH
A Bitbucket personal access token with basic auth support. For clearification user:token has to be the value of this env.
GIT_CREDENTIALS
​URL encoded Git username and password in the format <username>:<password>. The username and password must each be individually URL encoded, not the : separating them.
Alternatively the Git authentication can be set up via SSH keys.

Authentication for plugins

Most semantic-release plugins require setting up authentication in order to publish to a package manager registry. The default @semantic-release/npm and @semantic-release/github plugins require the following environment variables:
Variable
Description
NPM_TOKEN
npm token created via npm token create. Note: Only the auth-only level of npm two-factor authentication is supported.
GH_TOKEN
GitHub authentication token. Note: Only the personal token authentication is supported.
See each plugin's documentation for the environment variables required.
The authentication token/credentials have to be made available in the CI service via environment variables.
See CI configuration recipes for more details on how to configure environment variables in your CI service.
Note: The environment variables GH_TOKEN, GITHUB_TOKEN, GL_TOKEN and GITLAB_TOKEN can be used for both the Git authentication and the API authentication required by @semantic-release/github and @semantic-release/gitlab.
Usage - Previous
Installation
Next - Usage
Configuration
Last modified 4d ago
Copy link
Edit on GitHub
Contents
Run semantic-release only after all tests succeeded
Authentication
Push access to the remote repository
Authentication for plugins