{"_id":"@alphy11/semantic-release-gitlab","_rev":"1-2021b7f3df88e37359767cfd10e245b2","name":"@alphy11/semantic-release-gitlab","dist-tags":{"latest":"0.0.0-development"},"versions":{"0.0.0-development":{"name":"@alphy11/semantic-release-gitlab","description":"semantic-release plugin to publish a GitLab release","version":"0.0.0-development","author":{"name":"Pierre Vanduynslager","url":"https://twitter.com/@pvdlg_"},"ava":{"files":["test/**/*.test.js"]},"bugs":{"url":"https://github.com/semantic-release/gitlab/issues"},"contributors":[{"name":"Stephan Bönnemann","email":"stephan@boennemann.me","url":"http://boennemann.me"},{"name":"Gregor Martynus","url":"https://twitter.com/gr2m"}],"dependencies":{"@semantic-release/error":"^2.2.0","aggregate-error":"^3.0.0","debug":"^4.0.0","dir-glob":"^3.0.0","escape-string-regexp":"^3.0.0","form-data":"^3.0.0","fs-extra":"^9.0.0","globby":"^11.0.0","got":"^10.5.2","lodash":"^4.17.11","parse-path":"^4.0.0","url-join":"^4.0.0"},"devDependencies":{"ava":"^3.1.0","clear-module":"^4.0.0","codecov":"^3.0.0","nock":"^12.0.0","nyc":"^15.0.0","semantic-release":"^17.0.0","sinon":"^9.0.0","tempy":"^0.5.0","xo":"^0.28.0"},"engines":{"node":">=10.18"},"homepage":"https://github.com/semantic-release/gitlab#readme","keywords":["git","gitlab","publish","release","semantic-release","version"],"license":"MIT","main":"index.js","nyc":{"include":["lib/**/*.js","index.js"],"reporter":["json","text","html"],"all":true},"peerDependencies":{"semantic-release":">=15.8.0 <18.0.0"},"prettier":{"printWidth":120,"trailingComma":"es5"},"publishConfig":{"access":"public"},"repository":{"type":"git","url":"git+https://github.com/semantic-release/gitlab.git"},"scripts":{"codecov":"codecov -f coverage/coverage-final.json","lint":"xo","pretest":"npm run lint","semantic-release":"semantic-release","test":"nyc ava -v"},"xo":{"prettier":true,"space":true,"rules":{"unicorn/string-content":"off"}},"gitHead":"11ee13542e014d1c1db289add0f8138294a6de3b","_id":"@alphy11/semantic-release-gitlab@0.0.0-development","_nodeVersion":"12.13.0","_npmVersion":"6.14.2","dist":{"integrity":"sha512-wbT9b9mGgNiCTUR0qpnH+nxw+Jg1LftETF6dRgQgaTXP1WBEbR604Xom9SGOxKE0qZNzFOLJjH7DhWV00SJmAg==","shasum":"74e607a034fe41b935a5b3d2dee0b7836d9e3083","tarball":"https://registry.npmjs.org/@alphy11/semantic-release-gitlab/-/semantic-release-gitlab-0.0.0-development.tgz","fileCount":11,"unpackedSize":25674,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfNam3CRA9TVsSAnZWagAAtDsQAJoCvSoa/66prlfLDR4Y\n0kZzHtCbAYRi+8oL3oATKNEhWx+QhGVN1Zqkq8l+Vg7xpbT/NrRx0B1g9EdS\nFTfYQke+IxvuZW4EBaVCOEZb/KUhyrv+XstX6yVBSf0OTIkDE/D1xB8sfqVq\nSS/iLqrFirNQtFxeMksC8wf+1vdZgF1NUPgoxAJLO1b8ryFNhG4+G2no0YpV\ngSDh56Kr0b8cJbfq/UwXpiEmOAZK+r1222V4Suz0AmMfLeIESBtUjpEqrdiB\n45k+5CZMATZ7ukeuoGpyBOPb/WznFEWCZJg2+iSj/OClED+1guiMY1MGBh2L\nnvt92UUcBos0gR5GQy4RrD1fhE2E4uxY2RRltJqSp7Oshzy8L8Q7Qb0sewab\nUZ40KrhmcfdeavfwTce5IkNajKngjUjNroGrAofh2zYkTA6TYzVMbsn1Eu0j\nz8gjzY/h5XweJyNSut0uctRwlsfU7XrTDg5o+wDfbeL0tPgyWX+DJqHjHiH0\nyvP8WwIchW6CIKoUjPSR6MFyWAB4tz7K44vTRcLLIbWII2KMgnYMLU9DKhEz\nmCiV9aFvo8yy2oYQhcM09YTNLKRFKRpnyF36hlG18+gSQTrg4c9g71JKuhHu\nqfRX2jpqdfLCQIMK3oHXyOFNOM6Ecn+Gi3RELuqcYt4d4npeRirW0QrlBD0w\nnNbr\r\n=PWWY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD//vMj/2bf+1j1VaSH0gp34XfCbZNsKX5slSb8jyONagIhAPAxR/IxsfzU+Ae/izwcuW5zXFURkjXSEsnojKzPdFDk"}]},"maintainers":[{"name":"alphy11","email":"tom.loel.williams@outlook.com"}],"_npmUser":{"name":"alphy11","email":"tom.loel.williams@outlook.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-gitlab_0.0.0-development_1597352374350_0.08037867865166404"},"_hasShrinkwrap":false}},"time":{"created":"2020-08-13T20:59:34.306Z","0.0.0-development":"2020-08-13T20:59:34.530Z","modified":"2022-04-04T13:38:34.403Z"},"maintainers":[{"name":"alphy11","email":"tom.loel.williams@outlook.com"}],"description":"semantic-release plugin to publish a GitLab release","homepage":"https://github.com/semantic-release/gitlab#readme","keywords":["git","gitlab","publish","release","semantic-release","version"],"repository":{"type":"git","url":"git+https://github.com/semantic-release/gitlab.git"},"contributors":[{"name":"Stephan Bönnemann","email":"stephan@boennemann.me","url":"http://boennemann.me"},{"name":"Gregor Martynus","url":"https://twitter.com/gr2m"}],"author":{"name":"Pierre Vanduynslager","url":"https://twitter.com/@pvdlg_"},"bugs":{"url":"https://github.com/semantic-release/gitlab/issues"},"license":"MIT","readme":"# @semantic-release/gitlab\r\n\r\n[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a\r\n[GitLab release](https://docs.gitlab.com/ce/workflow/releases.html).\r\n\r\n[![Travis](https://img.shields.io/travis/semantic-release/gitlab.svg)](https://travis-ci.org/semantic-release/gitlab)\r\n[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/gitlab.svg)](https://codecov.io/gh/semantic-release/gitlab)\r\n[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/gitlab.svg)](https://greenkeeper.io/)\r\n\r\n[![npm latest version](https://img.shields.io/npm/v/@semantic-release/gitlab/latest.svg)](https://www.npmjs.com/package/@semantic-release/gitlab)\r\n[![npm next version](https://img.shields.io/npm/v/@semantic-release/gitlab/next.svg)](https://www.npmjs.com/package/@semantic-release/gitlab)\r\n\r\n| Step               | Description                                                                                                           |\r\n|--------------------|-----------------------------------------------------------------------------------------------------------------------|\r\n| `verifyConditions` | Verify the presence and the validity of the authentication (set via [environment variables](#environment-variables)). |\r\n| `publish`          | Publish a [GitLab release](https://docs.gitlab.com/ce/workflow/releases.html).                                        |\r\n\r\n## Install\r\n\r\n```bash\r\n$ npm install @semantic-release/gitlab -D\r\n```\r\n\r\n## Usage\r\n\r\nThe plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):\r\n\r\n```json\r\n{\r\n  \"plugins\": [\r\n    \"@semantic-release/commit-analyzer\",\r\n    \"@semantic-release/release-notes-generator\",\r\n    [\"@semantic-release/gitlab\", {\r\n      \"gitlabUrl\": \"https://custom.gitlab.com\",\r\n      \"assets\": [\r\n        {\"path\": \"dist/asset.min.css\", \"label\": \"CSS distribution\"},\r\n        {\"path\": \"dist/asset.min.js\", \"label\": \"JS distribution\"}\r\n      ]\r\n    }],\r\n  ]\r\n}\r\n```\r\n\r\nWith this example [GitLab releases](https://docs.gitlab.com/ce/workflow/releases.html) will be published to the `https://custom.gitlab.com` instance.\r\n\r\n## Configuration\r\n\r\n### GitLab authentication\r\n\r\nThe GitLab authentication configuration is **required** and can be set via\r\n[environment variables](#environment-variables).\r\n\r\nCreate a [personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html) with the `api` scope and make it available in your CI environment via the `GL_TOKEN` environment variable. If you are using `GL_TOKEN` as the [remote Git repository authentication](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/ci-configuration.md#authentication) it must also have the `write_repository` scope.\r\n\r\n### Environment variables\r\n\r\n| Variable                       | Description                                               |\r\n|--------------------------------|-----------------------------------------------------------|\r\n| `GL_TOKEN` or `GITLAB_TOKEN`   | **Required.** The token used to authenticate with GitLab. |\r\n| `GL_URL` or `GITLAB_URL`       | The GitLab endpoint.                                      |\r\n| `GL_PREFIX` or `GITLAB_PREFIX` | The GitLab API prefix.                                    |\r\n\r\n### Options\r\n\r\n| Option                | Description                                                        | Default                                                                                                                                                                 |\r\n|-----------------------|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\r\n| `gitlabUrl`           | The GitLab endpoint.                                               | `GL_URL` or `GITLAB_URL` environment variable or CI provided environment variables if running on [GitLab CI/CD](https://docs.gitlab.com/ee/ci) or `https://gitlab.com`. |\r\n| `gitlabApiPathPrefix` | The GitLab API prefix.                                             | `GL_PREFIX` or `GITLAB_PREFIX` environment variable or CI provided environment variables if running on [GitLab CI/CD](https://docs.gitlab.com/ee/ci) or `/api/v4`.      |\r\n| `assets`              | An array of files to upload to the release. See [assets](#assets). | -                                                                                                                                                                       |\r\n\r\n#### assets\r\n\r\nCan be a [glob](https://github.com/isaacs/node-glob#glob-primer) or and `Array` of\r\n[globs](https://github.com/isaacs/node-glob#glob-primer) and `Object`s with the following properties:\r\n\r\n| Property | Description                                                                                              | Default                              |\r\n| -------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------ |\r\n| `path`   | **Required.** A [glob](https://github.com/isaacs/node-glob#glob-primer) to identify the files to upload. | -                                    |\r\n| `label`  | Short description of the file displayed on the GitLab release.                                           | File name extracted from the `path`. |\r\n\r\nEach entry in the `assets` `Array` is globbed individually. A [glob](https://github.com/isaacs/node-glob#glob-primer)\r\ncan be a `String` (`\"dist/**/*.js\"` or `\"dist/mylib.js\"`) or an `Array` of `String`s that will be globbed together\r\n(`[\"dist/**\", \"!**/*.css\"]`).\r\n\r\nIf a directory is configured, all the files under this directory and its children will be included.\r\n\r\n**Note**: If a file has a match in `assets` it will be included even if it also has a match in `.gitignore`.\r\n\r\n##### assets examples\r\n\r\n`'dist/*.js'`: include all the `js` files in the `dist` directory, but not in its sub-directories.\r\n\r\n`[['dist', '!**/*.css']]`: include all the files in the `dist` directory and its sub-directories excluding the `css`\r\nfiles.\r\n\r\n`[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS distribution'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS\r\ndistribution'}]`: include the `dist/MyLibrary.js` and `dist/MyLibrary.css` files, and label them `MyLibrary JS\r\ndistribution` and `MyLibrary CSS distribution` in the GitLab release.\r\n\r\n`[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]`: include all the `js` and\r\n`css` files in the `dist` directory and its sub-directories excluding the minified version, plus the\r\n`build/MyLibrary.zip` file and label it `MyLibrary` in the GitLab release.\r\n","readmeFilename":"README.md"}