|
1 | 1 | # @semantic-release/gitlab-config
|
2 | 2 |
|
3 |
| -[Semantic-release](https://github.com/semantic-release/semantic-release) shareable config for [GitLab](https://gitlab.com). |
| 3 | +[**semantic-release**](https://github.com/semantic-release/semantic-release) shareable config to publish npm packages with [GitLab](https://gitlab.com). |
4 | 4 |
|
5 | 5 | [](https://travis-ci.org/semantic-release/gitlab-config)
|
6 |
| -[](https://codecov.io/gh/semantic-release/gitlab-config) |
7 | 6 | [](https://greenkeeper.io/)
|
8 | 7 |
|
9 | 8 | [](https://www.npmjs.com/package/@semantic-release/gitlab-config)
|
10 | 9 | [](https://www.npmjs.com/package/@semantic-release/gitlab-config)
|
11 | 10 |
|
12 |
| -## Usage |
| 11 | +## Plugins |
| 12 | + |
| 13 | +This shareable configuration use the following plugins: |
| 14 | +- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer) |
| 15 | +- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator) |
| 16 | +- [`@semantic-release/npm`](https://github.com/semantic-release/npm) |
| 17 | +- [`@semantic-release/gitlab`](https://github.com/semantic-release/gitlab) |
13 | 18 |
|
14 |
| -### Local installation |
| 19 | +## Install |
15 | 20 |
|
16 | 21 | ```bash
|
17 | 22 | $ npm install --save-dev semantic-release @semantic-release/gitlab-config
|
18 | 23 | ```
|
19 | 24 |
|
20 |
| -In `package.json`: |
| 25 | +## Usage |
| 26 | + |
| 27 | +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): |
21 | 28 |
|
22 | 29 | ```json
|
23 | 30 | {
|
24 |
| - "release": { |
25 |
| - "extends": "@semantic-release/gitlab-config" |
26 |
| - } |
| 31 | + "extends": "@semantic-release/gitlab-config" |
27 | 32 | }
|
28 | 33 | ```
|
29 | 34 |
|
30 |
| -### Global installation |
31 |
| - |
32 |
| -```bash |
33 |
| -$ npm install -g semantic-release @semantic-release/gitlab-config |
34 |
| -$ semantic-release -e @semantic-release/gitlab-config |
35 |
| -``` |
36 |
| - |
37 | 35 | ## Configuration
|
38 | 36 |
|
39 |
| -### GitLab authentication |
40 |
| - |
41 |
| -The GitLab authentication configuration is **required** and can be set via [environment variables](#environment-variables). |
42 |
| - |
43 |
| -See [GitLab authentication](https://github.com/semantic-release/gitlab#gitlab-authentication). |
44 |
| - |
45 |
| -### Npm registry authentication |
46 |
| - |
47 |
| -The npm authentication configuration is **required** and can be set via [environment variables](#environment-variables). |
48 |
| - |
49 |
| -See [Npm registry authentication](https://github.com/semantic-release/npm#npm-registry-authentication) |
50 |
| - |
51 |
| -### Environment variables |
52 |
| - |
53 |
| -| Variable | Description | |
54 |
| -|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| |
55 |
| -| `GL_TOKEN` or `GITLAB_TOKEN` | **Required.** The token used to authenticate with GitLab repository. | |
56 |
| -| `NPM_TOKEN` | **Required.** Npm token created via [npm token create](https://docs.npmjs.com/getting-started/working_with_tokens#how-to-create-new-tokens) | |
57 |
| - |
58 |
| -### Additional options |
59 |
| - |
60 |
| -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. |
61 |
| -Options can be set in the Semantic-release configuration. |
62 |
| - |
63 |
| -For example to set a custom GitLab URL: |
64 |
| - |
65 |
| -```json |
66 |
| -{ |
67 |
| - "release": { |
68 |
| - "extends": "@semantic-release/gitlab-config", |
69 |
| - "gitlabUrl": "https://custom.gitlab.com" |
70 |
| - } |
71 |
| -} |
72 |
| -``` |
| 37 | +See each [plugin](#plugins) documentation for required installation and configuration steps. |
0 commit comments