-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Use new semantic-release `plugins` option - Update documentation - Remove test as the shareable config is purely static BREAKING CHANGE: require [email protected] or above
- Loading branch information
Showing
8 changed files
with
28 additions
and
547 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,72 +1,37 @@ | ||
# @semantic-release/gitlab-config | ||
|
||
[Semantic-release](https://github.com/semantic-release/semantic-release) shareable config for [GitLab](https://gitlab.com). | ||
[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to publish npm packages with [GitLab](https://gitlab.com). | ||
|
||
[![Travis](https://img.shields.io/travis/semantic-release/gitlab-config.svg)](https://travis-ci.org/semantic-release/gitlab-config) | ||
[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/gitlab-config.svg)](https://codecov.io/gh/semantic-release/gitlab-config) | ||
[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/gitlab-config.svg)](https://greenkeeper.io/) | ||
|
||
[![npm latest version](https://img.shields.io/npm/v/@semantic-release/gitlab-config/latest.svg)](https://www.npmjs.com/package/@semantic-release/gitlab-config) | ||
[![npm next version](https://img.shields.io/npm/v/@semantic-release/gitlab-config/next.svg)](https://www.npmjs.com/package/@semantic-release/gitlab-config) | ||
|
||
## Usage | ||
## Plugins | ||
|
||
This shareable configuration use the following plugins: | ||
- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer) | ||
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator) | ||
- [`@semantic-release/npm`](https://github.com/semantic-release/npm) | ||
- [`@semantic-release/gitlab`](https://github.com/semantic-release/gitlab) | ||
|
||
### Local installation | ||
## Install | ||
|
||
```bash | ||
$ npm install --save-dev semantic-release @semantic-release/gitlab-config | ||
``` | ||
|
||
In `package.json`: | ||
## Usage | ||
|
||
The shareable config can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration): | ||
|
||
```json | ||
{ | ||
"release": { | ||
"extends": "@semantic-release/gitlab-config" | ||
} | ||
"extends": "@semantic-release/gitlab-config" | ||
} | ||
``` | ||
|
||
### Global installation | ||
|
||
```bash | ||
$ npm install -g semantic-release @semantic-release/gitlab-config | ||
$ semantic-release -e @semantic-release/gitlab-config | ||
``` | ||
|
||
## Configuration | ||
|
||
### GitLab authentication | ||
|
||
The GitLab authentication configuration is **required** and can be set via [environment variables](#environment-variables). | ||
|
||
See [GitLab authentication](https://github.com/semantic-release/gitlab#gitlab-authentication). | ||
|
||
### Npm registry authentication | ||
|
||
The npm authentication configuration is **required** and can be set via [environment variables](#environment-variables). | ||
|
||
See [Npm registry authentication](https://github.com/semantic-release/npm#npm-registry-authentication) | ||
|
||
### Environment variables | ||
|
||
| Variable | Description | | ||
|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| | ||
| `GL_TOKEN` or `GITLAB_TOKEN` | **Required.** The token used to authenticate with GitLab repository. | | ||
| `NPM_TOKEN` | **Required.** Npm token created via [npm token create](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens) | | ||
|
||
### Additional options | ||
|
||
This shareable config uses the [`@semantic-release/npm`](https://github.com/semantic-release/npm) and [`@semantic-release/gitlab`](https://github.com/semantic-release/gitlab) plugins. See the documentation of each plugins for additional options. | ||
Options can be set in the Semantic-release configuration. | ||
|
||
For example to set a custom GitLab URL: | ||
|
||
```json | ||
{ | ||
"release": { | ||
"extends": "@semantic-release/gitlab-config", | ||
"gitlabUrl": "https://custom.gitlab.com" | ||
} | ||
} | ||
``` | ||
See each [plugin](#plugins) documentation for required installation and configuration steps. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,8 @@ | ||
module.exports = { | ||
verifyConditions: ['@semantic-release/npm', '@semantic-release/gitlab'], | ||
prepare: ['@semantic-release/npm'], | ||
publish: ['@semantic-release/npm', '@semantic-release/gitlab'], | ||
success: false, | ||
fail: false, | ||
plugins: [ | ||
'@semantic-release/commit-analyzer', | ||
'@semantic-release/release-notes-generator', | ||
'@semantic-release/npm', | ||
'@semantic-release/gitlab', | ||
], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.