https://github.com/lgaticaq/gitlab-rancher-config
Semantic-release shareable config for GitLab with Rancher
https://github.com/lgaticaq/gitlab-rancher-config
gitlab rancher semantic-release semantic-release-config
Last synced: 12 months ago
JSON representation
Semantic-release shareable config for GitLab with Rancher
- Host: GitHub
- URL: https://github.com/lgaticaq/gitlab-rancher-config
- Owner: lgaticaq
- License: mit
- Created: 2018-09-03T13:46:15.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-05-08T08:15:32.000Z (about 1 year ago)
- Last Synced: 2025-06-14T04:40:53.139Z (about 1 year ago)
- Topics: gitlab, rancher, semantic-release, semantic-release-config
- Language: JavaScript
- Size: 1.21 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# gitlab-rancher-config
[](https://www.npmjs.com/package/gitlab-rancher-config)
[](https://www.npmjs.com/package/gitlab-rancher-config)
[](https://travis-ci.org/lgaticaq/gitlab-rancher-config)
[](https://codeclimate.com/github/lgaticaq/gitlab-rancher-config/maintainability)
[](https://david-dm.org/lgaticaq/gitlab-rancher-config#info=devDependencies)
> [Semantic-release](https://github.com/semantic-release/semantic-release) shareable config for [GitLab](https://gitlab.com) with [Rancher](https://rancher.com/docs/rancher/v1.6/en/).
## Usage
### Local installation
```bash
npm i -D semantic-release gitlab-rancher-config
```
In `package.json`:
```json
{
"release": {
"extends": "gitlab-rancher-config"
}
}
```
### Global installation
```bash
$ npm i -g semantic-release gitlab-rancher-config @semantic-release/{changelog,git,gitlab,npm} semantic-release-gitlab-registry semantic-release-rancher
$ semantic-release -e gitlab-rancher-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) |
| `PLUGIN_SERVICE` | **Required.** Stack name and service name. Ex: `my_stack/my_name` |
| `RANCHER_ACCESS_KEY` | **Required.** A valid environment API access key |
| `RANCHER_SECRET_KEY` | **Required.** A valid environment API secret key |
| `RANCHER_URL` | **Required.** The environment API endpoint. Ex: `https://rancher.domain.com/v1/projects/{ID}` |
### Additional options
This shareable config uses the [`@semantic-release/changelog`](https://github.com/semantic-release/changelog), [`@semantic-release/git`](https://github.com/semantic-release/git), [`@semantic-release/gitlab`](https://github.com/semantic-release/gitlab), [`@semantic-release/npm`](https://github.com/semantic-release/npm), [`semantic-release-gitlab-registry`](https://github.com/lgaticaq/semantic-release-gitlab-registry) and [`semantic-release-rancher`](https://github.com/lgaticaq/semantic-release-rancher) 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": "gitlab-rancher-config",
"gitlabUrl": "https://custom.gitlab.com"
}
}
```
## License
[MIT](https://tldrlegal.com/license/mit-license)