Simple email application for Android. Original source code: https://framagit.org/dystopia-project/simple-email
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

65 lines
3.3 KiB

  1. # @semantic-release/gitlab
  2. [**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a
  3. [GitLab release](https://docs.gitlab.com/ce/workflow/releases.html).
  4. [![Travis](https://img.shields.io/travis/semantic-release/gitlab.svg)](https://travis-ci.org/semantic-release/gitlab)
  5. [![Codecov](https://img.shields.io/codecov/c/github/semantic-release/gitlab.svg)](https://codecov.io/gh/semantic-release/gitlab)
  6. [![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/gitlab.svg)](https://greenkeeper.io/)
  7. [![npm latest version](https://img.shields.io/npm/v/@semantic-release/gitlab/latest.svg)](https://www.npmjs.com/package/@semantic-release/gitlab)
  8. [![npm next version](https://img.shields.io/npm/v/@semantic-release/gitlab/next.svg)](https://www.npmjs.com/package/@semantic-release/gitlab)
  9. | Step | Description |
  10. |--------------------|-----------------------------------------------------------------------------------------------------------------------|
  11. | `verifyConditions` | Verify the presence and the validity of the authentication (set via [environment variables](#environment-variables)). |
  12. | `publish` | Publish a [GitLab release](https://docs.gitlab.com/ce/workflow/releases.html). |
  13. ## Install
  14. ```bash
  15. $ npm install @semantic-release/gitlab -D
  16. ```
  17. ## Usage
  18. The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/caribou/docs/usage/configuration.md#configuration):
  19. ```json
  20. {
  21. "plugins": [
  22. "@semantic-release/commit-analyzer",
  23. "@semantic-release/release-notes-generator",
  24. ["@semantic-release/gitlab", {
  25. "gitlabUrl": "https://custom.gitlab.com"
  26. }],
  27. ]
  28. }
  29. ```
  30. With this example [GitLab releases](https://docs.gitlab.com/ce/workflow/releases.html) will be published to the `https://custom.gitlab.com` instance.
  31. ## Configuration
  32. ### GitLab authentication
  33. The GitLab authentication configuration is **required** and can be set via
  34. [environment variables](#environment-variables).
  35. Only the [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html)
  36. authentication is supported.
  37. ### Environment variables
  38. | Variable | Description |
  39. |--------------------------------|-----------------------------------------------------------|
  40. | `GL_TOKEN` or `GITLAB_TOKEN` | **Required.** The token used to authenticate with GitLab. |
  41. | `GL_URL` or `GITLAB_URL` | The GitLab endpoint. |
  42. | `GL_PREFIX` or `GITLAB_PREFIX` | The GitLab API prefix. |
  43. ### Options
  44. | Option | Description | Default |
  45. |-----------------------|------------------------|------------------------------------------------------------------------|
  46. | `gitlabUrl` | The GitLab endpoint. | `GL_URL` or `GITLAB_URL` environment variable or `https://gitlab.com`. |
  47. | `gitlabApiPathPrefix` | The GitLab API prefix. | `GL_PREFIX` or `GITLAB_PREFIX` environment variable or `/api/v4`. |