{"_id":"@antongolub/semantic-release-github","_rev":"4-42844591b49c6dfb142f91a044cf6d9d","name":"@antongolub/semantic-release-github","dist-tags":{"beta":"0.0.4-beta","latest":"0.0.1-beta"},"versions":{"0.0.1-beta":{"name":"@antongolub/semantic-release-github","description":"semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues","version":"0.0.1-beta","private":false,"publishConfig":{"access":"public"},"author":{"name":"Pierre Vanduynslager","url":"https://twitter.com/@pvdlg_"},"ava":{"files":["test/**/*.test.js"]},"bugs":{"url":"https://github.com/semantic-release/github/issues"},"contributors":[{"name":"Stephan Bönnemann","email":"stephan@boennemann.me","url":"http://boennemann.me"},{"name":"Gregor Martynus","url":"https://twitter.com/gr2m"}],"dependencies":{"@octokit/rest":"^17.0.0","@semantic-release/error":"^2.2.0","aggregate-error":"^3.0.0","bottleneck":"^2.18.1","debug":"^4.0.0","dir-glob":"^3.0.0","fs-extra":"^9.0.0","globby":"^11.0.0","http-proxy-agent":"^4.0.0","https-proxy-agent":"^5.0.0","issue-parser":"^6.0.0","lodash":"^4.17.4","mime":"^2.4.3","p-filter":"^2.0.0","p-retry":"^4.0.0","url-join":"^4.0.0"},"devDependencies":{"ava":"^3.1.0","clear-module":"^4.0.0","codecov":"^3.5.0","nock":"^12.0.0","nyc":"^15.0.0","proxy":"^1.0.0","proxyquire":"^2.0.0","semantic-release":"^17.0.0","server-destroy":"^1.0.1","sinon":"^9.0.0","tempy":"^0.5.0","xo":"^0.30.0"},"engines":{"node":">=10.18"},"homepage":"https://github.com/semantic-release/github#readme","keywords":["git","github","issue","notifications","publish","pull-request","release","semantic-release","version"],"license":"MIT","main":"index.js","nyc":{"include":["lib/**/*.js","index.js"],"reporter":["json","text","html"],"all":true},"peerDependencies":{"semantic-release":">=16.0.0 <18.0.0"},"prettier":{"printWidth":120,"trailingComma":"es5"},"repository":{"type":"git","url":"git+https://github.com/semantic-release/github.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":{"camelcase":["error",{"properties":"never"}],"unicorn/string-content":"off"}},"gitHead":"32654fb26dbba597170408ab181255ae863ed748","_id":"@antongolub/semantic-release-github@0.0.1-beta","_nodeVersion":"14.5.0","_npmVersion":"6.14.5","dist":{"integrity":"sha512-VY6BP0Iz5AxPePETtcbpXwkpsqddiUdVDS9fUrZcXjjv8kpA7FXKPYrhuSQKr92Na69Xsy7m+F5CgMgB5GTaaQ==","shasum":"7728649c3dc449e79303b9c62e9e4e1a05f2646e","tarball":"https://registry.npmjs.org/@antongolub/semantic-release-github/-/semantic-release-github-0.0.1-beta.tgz","fileCount":22,"unpackedSize":62141,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIvykCRA9TVsSAnZWagAArSsP/jYHhZfaF77ae71CoVnf\nElNAl60MXV5wfVxaxQxPiJT7wERF+9CrWv2raieUuRvPcWtvnjLFOh4oBtqd\nH6rtnyba5MGfr4fwU+nz7+uaMpXvXqum6T3XzoAhA6UfpgGYUBhUQFjFUy9o\nbQLomEY1MmI7sQ/w/+S+ygKwDK2tNQPLs5ljlGMD4L/Axo05Y3///Ra9G7d2\ndvjDRuRJFvWrtyYQ0WCCWNnhzGz9YVsKThBDTP5dDh+UYaVqsKwIsPZwwi+A\ndtAc1+6Ds67IPaYF1z7ydPNRSZLiRNWTlDmsxoFv44e5zeVGnAeJQaA3jRlL\nyw4z1l8xQXO6+Kxv0ey2tkddqsEt++uC4z0WWBPCTyDahwWdct2d+09HGKdS\nLp8l6n1ICvQY/ixikwcZyldDWFkZcsnXP9r3CojVXwWAntwH2qnVBpdT7D2u\nN/+3K6xV9llwgaGqszFBUAkAIXhnglZryBbpMSdxGKHvS7ZNI05H+YVXzoJr\n8WJ7nNhaXi7C1K1/tKIrhhYk0BEBoa08A4Q9b/zWHG/kLW+Ssui4eqsoz1ro\nsR9CUMAAmfYnbQF4C885vuWotvoMW0y6B5Al9jY6loR3mHRtTOXNzFWADKpL\nvz+YDuZ3Ox9OQTa0KPsYXjLmLtAufotv00gAgUqQZE6kQyehcwA/AgStJHq6\nFXWj\r\n=ej5y\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFx3apNrDkuyfZLmn93NPaoXGpGw/uqswuiA2l1uCuAkAiEAomaHDvbr9KVvxKKA+Lb5Ye8C0udvzZXhoYzsOeyW8Do="}]},"maintainers":[{"name":"antongolub","email":"golub.anton@gmail.com"}],"_npmUser":{"name":"antongolub","email":"golub.anton@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-github_0.0.1-beta_1596128419997_0.38559204932967805"},"_hasShrinkwrap":false},"0.0.2-beta":{"name":"@antongolub/semantic-release-github","description":"semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues","version":"0.0.2-beta","private":false,"publishConfig":{"access":"public"},"author":{"name":"Pierre Vanduynslager","url":"https://twitter.com/@pvdlg_"},"ava":{"files":["test/**/*.test.js"]},"bugs":{"url":"https://github.com/semantic-release/github/issues"},"contributors":[{"name":"Stephan Bönnemann","email":"stephan@boennemann.me","url":"http://boennemann.me"},{"name":"Gregor Martynus","url":"https://twitter.com/gr2m"}],"dependencies":{"@octokit/rest":"^17.0.0","@semantic-release/error":"^2.2.0","aggregate-error":"^3.0.0","bottleneck":"^2.18.1","debug":"^4.0.0","dir-glob":"^3.0.0","fs-extra":"^9.0.0","globby":"^11.0.0","http-proxy-agent":"^4.0.0","https-proxy-agent":"^5.0.0","issue-parser":"^6.0.0","lodash":"^4.17.4","mime":"^2.4.3","p-filter":"^2.0.0","p-retry":"^4.0.0","url-join":"^4.0.0"},"devDependencies":{"ava":"^3.1.0","clear-module":"^4.0.0","codecov":"^3.5.0","nock":"^12.0.0","nyc":"^15.0.0","proxy":"^1.0.0","proxyquire":"^2.0.0","semantic-release":"^17.0.0","server-destroy":"^1.0.1","sinon":"^9.0.0","tempy":"^0.5.0","xo":"^0.30.0"},"engines":{"node":">=10.18"},"homepage":"https://github.com/semantic-release/github#readme","keywords":["git","github","issue","notifications","publish","pull-request","release","semantic-release","version"],"license":"MIT","main":"index.js","nyc":{"include":["lib/**/*.js","index.js"],"reporter":["json","text","html"],"all":true},"peerDependencies":{"semantic-release":">=16.0.0 <18.0.0"},"prettier":{"printWidth":120,"trailingComma":"es5"},"repository":{"type":"git","url":"git+https://github.com/semantic-release/github.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":{"camelcase":["error",{"properties":"never"}],"unicorn/string-content":"off"}},"readme":"# @semantic-release/github\n\n[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a\n[GitHub release](https://help.github.com/articles/about-releases) and comment on released Pull Requests/Issues.\n\n[![Travis](https://img.shields.io/travis/semantic-release/github.svg)](https://travis-ci.org/semantic-release/github)\n[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/github.svg)](https://codecov.io/gh/semantic-release/github)\n[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/github.svg)](https://greenkeeper.io/)\n\n[![npm latest version](https://img.shields.io/npm/v/@semantic-release/github/latest.svg)](https://www.npmjs.com/package/@semantic-release/github)\n[![npm next version](https://img.shields.io/npm/v/@semantic-release/github/next.svg)](https://www.npmjs.com/package/@semantic-release/github)\n[![npm beta version](https://img.shields.io/npm/v/@semantic-release/github/beta.svg)](https://www.npmjs.com/package/@semantic-release/github)\n\n| Step               | Description                                                                                                                                                                                                                              |\n|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `verifyConditions` | Verify the presence and the validity of the authentication (set via [environment variables](#environment-variables)) and the [assets](#assets) option configuration.                                                                     |\n| `publish`          | Publish a [GitHub release](https://help.github.com/articles/about-releases), optionally uploading file assets.                                                                                                                           |\n| `addChannel`       | Update a [GitHub release](https://help.github.com/articles/about-releases)'s `pre-release` field.                                                                                                                                        |\n| `success`          | Add a comment to each [GitHub Issue](https://help.github.com/articles/about-issues) or [Pull Request](https://help.github.com/articles/about-pull-requests) resolved by the release and close issues previously open by the `fail` step. |\n| `fail`             | Open or update a [GitHub Issue](https://help.github.com/articles/about-issues) with information about the errors that caused the release to fail.                                                                                        |\n\n## Install\n\n```bash\n$ npm install @semantic-release/github -D\n```\n\n## Usage\n\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):\n\n```json\n{\n  \"plugins\": [\n    \"@semantic-release/commit-analyzer\",\n    \"@semantic-release/release-notes-generator\",\n    [\"@semantic-release/github\", {\n      \"assets\": [\n        {\"path\": \"dist/asset.min.css\", \"label\": \"CSS distribution\"},\n        {\"path\": \"dist/asset.min.js\", \"label\": \"JS distribution\"}\n      ]\n    }],\n  ]\n}\n```\n\nWith this example [GitHub releases](https://help.github.com/articles/about-releases) will be published with the file `dist/asset.min.css` and `dist/asset.min.js`.\n\n## Configuration\n\n### GitHub authentication\n\nThe GitHub authentication configuration is **required** and can be set via [environment variables](#environment-variables).\n\nFollow the [Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) documentation to obtain an authentication token. The token has to be made available in your CI environment via the `GH_TOKEN` environment variable. The user associated with the token must have push permission to the repository.\n\nWhen creating the token, the **minimum required scopes** are:\n\n- [`repo`](https://github.com/settings/tokens/new?scopes=repo) for a private repository\n- [`public_repo`](https://github.com/settings/tokens/new?scopes=public_repo) for a public repository\n\n_Note on GitHub Actions:_ You can use the default token which is provided in  the secret _GITHUB_TOKEN_. However releases done with this token will NOT trigger release events to start other workflows.\nIf you have actions that trigger on newly created releases, please use a generated token for that and store it in your repository's secrets (any other name than GITHUB_TOKEN is fine).\n\n### Environment variables\n\n| Variable                                           | Description                                               |\n| -------------------------------------------------- | --------------------------------------------------------- |\n| `GH_TOKEN` or `GITHUB_TOKEN`                       | **Required.** The token used to authenticate with GitHub. |\n| `GITHUB_API_URL` or `GH_URL` or `GITHUB_URL`       | The GitHub Enterprise endpoint.                           |\n| `GH_PREFIX` or `GITHUB_PREFIX`                     | The GitHub Enterprise API prefix.                         |\n\n### Options\n\n| Option                | Description                                                                                                                                                                                            | Default                                                                                                                                              |\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `githubUrl`           | The GitHub Enterprise endpoint.                                                                                                                                                                        | `GH_URL` or `GITHUB_URL` environment variable.                                                                                                       |\n| `githubApiPathPrefix` | The GitHub Enterprise API prefix.                                                                                                                                                                      | `GH_PREFIX` or `GITHUB_PREFIX` environment variable.                                                                                                 |\n| `proxy`               | The proxy to use to access the GitHub API. See [proxy](#proxy).                                                                                                                                        | `HTTP_PROXY` environment variable.                                                                                                                   |\n| `assets`              | An array of files to upload to the release. See [assets](#assets).                                                                                                                                     | -                                                                                                                                                    |\n| `successComment`      | The comment to add to each issue and pull request resolved by the release. Set to `false` to disable commenting on issues and pull requests. See [successComment](#successcomment).                    | `:tada: This issue has been resolved in version ${nextRelease.version} :tada:\\n\\nThe release is available on [GitHub release](<github_release_url>)` |\n| `failComment`         | The content of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails. See [failComment](#failcomment).                                               | Friendly message with links to **semantic-release** documentation and support, with the list of errors that caused the release to fail.              |\n| `failTitle`           | The title of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails.                                                                                  | `The automated release is failing 🚨`                                                                                                                |\n| `labels`              | The [labels](https://help.github.com/articles/about-labels) to add to the issue created when a release fails. Set to `false` to not add any label.                                                     | `['semantic-release']`                                                                                                                               |\n| `assignees`           | The [assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users) to add to the issue created when a release fails.                                           | -                                                                                                                                                    |\n| `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \\` on @\\${nextRelease.channel}\\` : \"\" %>']`                                                                     |\n\n#### proxy\n\nCan be a the proxy URL or and `Object` with the following properties:\n\n| Property      | Description                                                    | Default                              |\n|---------------|----------------------------------------------------------------|--------------------------------------|\n| `host`        | **Required.** Proxy host to connect to.                        | -                                    |\n| `port`        | **Required.** Proxy port to connect to.                        | File name extracted from the `path`. |\n| `secureProxy` | If `true`, then use TLS to connect to the proxy.               | `false`                              |\n| `headers`     | Additional HTTP headers to be sent on the HTTP CONNECT method. | -                                    |\n\nSee [node-https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options) and [node-http-proxy-agent](https://github.com/TooTallNate/node-http-proxy-agent) for additional details.\n\n##### proxy examples\n\n`'http://168.63.76.32:3128'`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request.\n`{host: '168.63.76.32', port: 3128, headers: {Foo: 'bar'}}`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request, setting the `Foo` header value to `bar`.\n\n#### assets\n\nCan be a [glob](https://github.com/isaacs/node-glob#glob-primer) or and `Array` of\n[globs](https://github.com/isaacs/node-glob#glob-primer) and `Object`s with the following properties:\n\n| Property | Description                                                                                              | Default                              |\n| -------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| `path`   | **Required.** A [glob](https://github.com/isaacs/node-glob#glob-primer) to identify the files to upload. | -                                    |\n| `name`   | The name of the downloadable file on the GitHub release.                                                 | File name extracted from the `path`. |\n| `label`  | Short description of the file displayed on the GitHub release.                                           | -                                    |\n\nEach entry in the `assets` `Array` is globbed individually. A [glob](https://github.com/isaacs/node-glob#glob-primer)\ncan be a `String` (`\"dist/**/*.js\"` or `\"dist/mylib.js\"`) or an `Array` of `String`s that will be globbed together\n(`[\"dist/**\", \"!**/*.css\"]`).\n\nIf a directory is configured, all the files under this directory and its children will be included.\n\nThe `name` and `label` for each assets are generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                         |\n|---------------|-------------------------------------------------------------------------------------|\n| `branch`      | The branch from which the release is done.                                          |\n| `lastRelease` | `Object` with `version`, `gitTag` and `gitHead` of the last release.                |\n| `nextRelease` | `Object` with `version`, `gitTag`, `gitHead` and `notes` of the release being done. |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.  |\n\n**Note**: If a file has a match in `assets` it will be included even if it also has a match in `.gitignore`.\n\n##### assets examples\n\n`'dist/*.js'`: include all the `js` files in the `dist` directory, but not in its sub-directories.\n\n`[['dist', '!**/*.css']]`: include all the files in the `dist` directory and its sub-directories excluding the `css`\nfiles.\n\n`[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS distribution'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS\ndistribution'}]`: include the `dist/MyLibrary.js` and `dist/MyLibrary.css` files, and label them `MyLibrary JS\ndistribution` and `MyLibrary CSS distribution` in the GitHub release.\n\n`[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]`: include all the `js` and\n`css` files in the `dist` directory and its sub-directories excluding the minified version, plus the\n`build/MyLibrary.zip` file and label it `MyLibrary` in the GitHub release.\n\n`[{path: 'dist/MyLibrary.js', name: 'MyLibrary-${nextRelease.gitTag}.js', label: 'MyLibrary JS (${nextRelease.gitTag}) distribution'}]`: include the file `dist/MyLibrary.js` and upload it to the GitHub release with name `MyLibrary-v1.0.0.js` and label `MyLibrary JS (v1.0.0) distribution` which will generate the link:\n\n> `[MyLibrary JS (v1.0.0) distribution](MyLibrary-v1.0.0.js)`\n\n#### successComment\n\nThe message for the issue comments is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                                                                                                                                                                                                                   |\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`      | `Object` with `name`, `type`, `channel`, `range` and `prerelease` properties of the branch from which the release is done.                                                                                                                                                    |\n| `lastRelease` | `Object` with `version`, `channel`, `gitTag` and `gitHead` of the last release.                                                                                                                                                                                               |\n| `nextRelease` | `Object` with `version`, `channel`, `gitTag`, `gitHead` and `notes` of the release being done.                                                                                                                                                                                |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.                                                                                                                                                                                            |\n| `releases`    | `Array` with a release `Object`s for each release published, with optional release data such as `name` and `url`.                                                                                                                                                             |\n| `issue`       | A [GitHub API pull request object](https://developer.github.com/v3/search/#search-issues) for pull requests related to a commit, or an `Object` with the `number` property for issues resolved via [keywords](https://help.github.com/articles/closing-issues-using-keywords) |\n\n##### successComment example\n\nThe `successComment` `This ${issue.pull_request ? 'pull request' : 'issue'} is included in version ${nextRelease.version}` will generate the comment:\n\n> This pull request is included in version 1.0.0\n\n#### failComment\n\nThe message for the issue content is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter | Description                                                                                                                                                                                                                                                                                                            |\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`  | The branch from which the release had failed.                                                                                                                                                                                                                                                                          |\n| `errors`  | An `Array` of [SemanticReleaseError](https://github.com/semantic-release/error). Each error has the `message`, `code`, `pluginName` and `details` properties.<br>`pluginName` contains the package name of the plugin that threw the error.<br>`details` contains a information about the error formatted in markdown. |\n\n##### failComment example\n\nThe `failComment` `This release from branch ${branch.name} had failed due to the following errors:\\n- ${errors.map(err => err.message).join('\\\\n- ')}` will generate the comment:\n\n> This release from branch master had failed due to the following errors:\n> - Error message 1\n> - Error message 2\n\n#### releasedLabels\n\nEach label name is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                                                                                                                                                                                                                   |\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`      | `Object` with `name`, `type`, `channel`, `range` and `prerelease` properties of the branch from which the release is done.                                                                                                                                                    |\n| `lastRelease` | `Object` with `version`, `channel`, `gitTag` and `gitHead` of the last release.                                                                                                                                                                                               |\n| `nextRelease` | `Object` with `version`, `channel`, `gitTag`, `gitHead` and `notes` of the release being done.                                                                                                                                                                                |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.                                                                                                                                                                                            |\n| `releases`    | `Array` with a release `Object`s for each release published, with optional release data such as `name` and `url`.                                                                                                                                                             |\n| `issue`       | A [GitHub API pull request object](https://developer.github.com/v3/search/#search-issues) for pull requests related to a commit, or an `Object` with the `number` property for issues resolved via [keywords](https://help.github.com/articles/closing-issues-using-keywords) |\n\n##### releasedLabels example\n\nThe `releasedLabels` ```['released<%= nextRelease.channel ? ` on @\\${nextRelease.channel}` : \"\" %> from <%= branch.name %>']``` will generate the label:\n\n> released on @next from branch next\n","readmeFilename":"README.md","gitHead":"32654fb26dbba597170408ab181255ae863ed748","_id":"@antongolub/semantic-release-github@0.0.2-beta","_nodeVersion":"14.5.0","_npmVersion":"6.14.5","dist":{"integrity":"sha512-O9iZgG2PwS3xOuITFVETsZyq7jPvnvM9sfiQQqxd+d3E+Ql+hOYT1FVHuZAPIxjGczqfIEmTWlAHsfP1cXzYrA==","shasum":"ff69e46d56bcef82e8da644bf8b4b1f6be5fc910","tarball":"https://registry.npmjs.org/@antongolub/semantic-release-github/-/semantic-release-github-0.0.2-beta.tgz","fileCount":22,"unpackedSize":62152,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIv47CRA9TVsSAnZWagAAVuUQAI64XD0aarE+qGbzX8Oo\nPUtwzw1zguOSDgFfBQAZUWcj2iDU3HndM/NUQ3XC8UwL7qnwKUTB994dkPS9\nSpxut4WivGjcmPAF0ve6R7i6glpsZrryqoRSmOXL7r6ASDvGIu+dQJ7GIUeM\ngm8WGhXLZ4winLpG4R8R00dgPPIlUS1Z6Vj0DO9Oax4uBwfoS+DjBZMztY/b\nWZ1/DHNXA6tMWK25/+C0SDZ6dG/THTx4Tadhakd9eqCLS+UCknnkjd0DzDcm\nK/VlVouLsWVndqbispFPjrL9+xJKrWP1vmvjuJMJmXHOu3ADs3uDYeyF4sUT\nIYJm5zCcqMyAx23JEsBm98S2eDcKEVRMPMDqXa13GhERQRx4SkDBDeFuAfTH\ni5cIsirrg+w8kxf5uc044tG9PDwXgeeZyNmtYtcRo0nqbQsxMq9UIVE/7AiQ\nMxUq9aC34jlCd13LXbyi+Crh5IpjebwEFQE6bisVSgAIkju1dyksQxTtV5JC\njxmoHtp/7nwWwRpPthis8zecAYVDWTrT7ab42qrl8pLklL50CFp1ak9HzgHU\npckupiT2Cp7BcsBXFEvzKwRZUmt6RSQ7d6SJ88+N6Rjq319OFXYuBR6qsVgK\nyRBNBr556ejN1jotaCHN+Y9dsBvy8UDlN5A1H0Dx1xS0gXn3unR8ed7c0Au1\nMM6W\r\n=UZxD\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIATGnOxl+LSNzP2cHutGu+py9MI47ygVNI6Oq8Tbr5DCAiEA05HgpJotzdVPKwHULZ2FE00TPUlsVLvTEd9zozzWLkw="}]},"maintainers":[{"name":"antongolub","email":"golub.anton@gmail.com"}],"_npmUser":{"name":"antongolub","email":"golub.anton@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-github_0.0.2-beta_1596128827022_0.21668222288547856"},"_hasShrinkwrap":false},"0.0.3-beta":{"name":"@antongolub/semantic-release-github","description":"semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues","version":"0.0.3-beta","private":false,"publishConfig":{"access":"public"},"author":{"name":"Pierre Vanduynslager","url":"https://twitter.com/@pvdlg_"},"ava":{"files":["test/**/*.test.js"]},"bugs":{"url":"https://github.com/semantic-release/github/issues"},"contributors":[{"name":"Stephan Bönnemann","email":"stephan@boennemann.me","url":"http://boennemann.me"},{"name":"Gregor Martynus","url":"https://twitter.com/gr2m"}],"dependencies":{"@octokit/rest":"^17.0.0","@semantic-release/error":"^2.2.0","aggregate-error":"^3.0.0","bottleneck":"^2.18.1","debug":"^4.0.0","dir-glob":"^3.0.0","fs-extra":"^9.0.0","globby":"^11.0.0","http-proxy-agent":"^4.0.0","https-proxy-agent":"^5.0.0","issue-parser":"^6.0.0","lodash":"^4.17.4","mime":"^2.4.3","p-filter":"^2.0.0","p-retry":"^4.0.0","url-join":"^4.0.0"},"devDependencies":{"ava":"^3.1.0","clear-module":"^4.0.0","codecov":"^3.5.0","nock":"^12.0.0","nyc":"^15.0.0","proxy":"^1.0.0","proxyquire":"^2.0.0","semantic-release":"^17.0.0","server-destroy":"^1.0.1","sinon":"^9.0.0","tempy":"^0.5.0","xo":"^0.30.0"},"engines":{"node":">=10.18"},"homepage":"https://github.com/semantic-release/github#readme","keywords":["git","github","issue","notifications","publish","pull-request","release","semantic-release","version"],"license":"MIT","main":"index.js","nyc":{"include":["lib/**/*.js","index.js"],"reporter":["json","text","html"],"all":true},"peerDependencies":{"semantic-release":">=16.0.0 <18.0.0"},"prettier":{"printWidth":120,"trailingComma":"es5"},"repository":{"type":"git","url":"git+https://github.com/semantic-release/github.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":{"camelcase":["error",{"properties":"never"}],"unicorn/string-content":"off"}},"readme":"# @semantic-release/github\n\n[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a\n[GitHub release](https://help.github.com/articles/about-releases) and comment on released Pull Requests/Issues.\n\n[![Travis](https://img.shields.io/travis/semantic-release/github.svg)](https://travis-ci.org/semantic-release/github)\n[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/github.svg)](https://codecov.io/gh/semantic-release/github)\n[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/github.svg)](https://greenkeeper.io/)\n\n[![npm latest version](https://img.shields.io/npm/v/@semantic-release/github/latest.svg)](https://www.npmjs.com/package/@semantic-release/github)\n[![npm next version](https://img.shields.io/npm/v/@semantic-release/github/next.svg)](https://www.npmjs.com/package/@semantic-release/github)\n[![npm beta version](https://img.shields.io/npm/v/@semantic-release/github/beta.svg)](https://www.npmjs.com/package/@semantic-release/github)\n\n| Step               | Description                                                                                                                                                                                                                              |\n|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `verifyConditions` | Verify the presence and the validity of the authentication (set via [environment variables](#environment-variables)) and the [assets](#assets) option configuration.                                                                     |\n| `publish`          | Publish a [GitHub release](https://help.github.com/articles/about-releases), optionally uploading file assets.                                                                                                                           |\n| `addChannel`       | Update a [GitHub release](https://help.github.com/articles/about-releases)'s `pre-release` field.                                                                                                                                        |\n| `success`          | Add a comment to each [GitHub Issue](https://help.github.com/articles/about-issues) or [Pull Request](https://help.github.com/articles/about-pull-requests) resolved by the release and close issues previously open by the `fail` step. |\n| `fail`             | Open or update a [GitHub Issue](https://help.github.com/articles/about-issues) with information about the errors that caused the release to fail.                                                                                        |\n\n## Install\n\n```bash\n$ npm install @semantic-release/github -D\n```\n\n## Usage\n\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):\n\n```json\n{\n  \"plugins\": [\n    \"@semantic-release/commit-analyzer\",\n    \"@semantic-release/release-notes-generator\",\n    [\"@semantic-release/github\", {\n      \"assets\": [\n        {\"path\": \"dist/asset.min.css\", \"label\": \"CSS distribution\"},\n        {\"path\": \"dist/asset.min.js\", \"label\": \"JS distribution\"}\n      ]\n    }],\n  ]\n}\n```\n\nWith this example [GitHub releases](https://help.github.com/articles/about-releases) will be published with the file `dist/asset.min.css` and `dist/asset.min.js`.\n\n## Configuration\n\n### GitHub authentication\n\nThe GitHub authentication configuration is **required** and can be set via [environment variables](#environment-variables).\n\nFollow the [Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) documentation to obtain an authentication token. The token has to be made available in your CI environment via the `GH_TOKEN` environment variable. The user associated with the token must have push permission to the repository.\n\nWhen creating the token, the **minimum required scopes** are:\n\n- [`repo`](https://github.com/settings/tokens/new?scopes=repo) for a private repository\n- [`public_repo`](https://github.com/settings/tokens/new?scopes=public_repo) for a public repository\n\n_Note on GitHub Actions:_ You can use the default token which is provided in  the secret _GITHUB_TOKEN_. However releases done with this token will NOT trigger release events to start other workflows.\nIf you have actions that trigger on newly created releases, please use a generated token for that and store it in your repository's secrets (any other name than GITHUB_TOKEN is fine).\n\n### Environment variables\n\n| Variable                                           | Description                                               |\n| -------------------------------------------------- | --------------------------------------------------------- |\n| `GH_TOKEN` or `GITHUB_TOKEN`                       | **Required.** The token used to authenticate with GitHub. |\n| `GITHUB_API_URL` or `GH_URL` or `GITHUB_URL`       | The GitHub Enterprise endpoint.                           |\n| `GH_PREFIX` or `GITHUB_PREFIX`                     | The GitHub Enterprise API prefix.                         |\n\n### Options\n\n| Option                | Description                                                                                                                                                                                            | Default                                                                                                                                              |\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `githubUrl`           | The GitHub Enterprise endpoint.                                                                                                                                                                        | `GH_URL` or `GITHUB_URL` environment variable.                                                                                                       |\n| `githubApiPathPrefix` | The GitHub Enterprise API prefix.                                                                                                                                                                      | `GH_PREFIX` or `GITHUB_PREFIX` environment variable.                                                                                                 |\n| `proxy`               | The proxy to use to access the GitHub API. See [proxy](#proxy).                                                                                                                                        | `HTTP_PROXY` environment variable.                                                                                                                   |\n| `assets`              | An array of files to upload to the release. See [assets](#assets).                                                                                                                                     | -                                                                                                                                                    |\n| `successComment`      | The comment to add to each issue and pull request resolved by the release. Set to `false` to disable commenting on issues and pull requests. See [successComment](#successcomment).                    | `:tada: This issue has been resolved in version ${nextRelease.version} :tada:\\n\\nThe release is available on [GitHub release](<github_release_url>)` |\n| `failComment`         | The content of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails. See [failComment](#failcomment).                                               | Friendly message with links to **semantic-release** documentation and support, with the list of errors that caused the release to fail.              |\n| `failTitle`           | The title of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails.                                                                                  | `The automated release is failing 🚨`                                                                                                                |\n| `labels`              | The [labels](https://help.github.com/articles/about-labels) to add to the issue created when a release fails. Set to `false` to not add any label.                                                     | `['semantic-release']`                                                                                                                               |\n| `assignees`           | The [assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users) to add to the issue created when a release fails.                                           | -                                                                                                                                                    |\n| `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \\` on @\\${nextRelease.channel}\\` : \"\" %>']`                                                                     |\n\n#### proxy\n\nCan be a the proxy URL or and `Object` with the following properties:\n\n| Property      | Description                                                    | Default                              |\n|---------------|----------------------------------------------------------------|--------------------------------------|\n| `host`        | **Required.** Proxy host to connect to.                        | -                                    |\n| `port`        | **Required.** Proxy port to connect to.                        | File name extracted from the `path`. |\n| `secureProxy` | If `true`, then use TLS to connect to the proxy.               | `false`                              |\n| `headers`     | Additional HTTP headers to be sent on the HTTP CONNECT method. | -                                    |\n\nSee [node-https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options) and [node-http-proxy-agent](https://github.com/TooTallNate/node-http-proxy-agent) for additional details.\n\n##### proxy examples\n\n`'http://168.63.76.32:3128'`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request.\n`{host: '168.63.76.32', port: 3128, headers: {Foo: 'bar'}}`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request, setting the `Foo` header value to `bar`.\n\n#### assets\n\nCan be a [glob](https://github.com/isaacs/node-glob#glob-primer) or and `Array` of\n[globs](https://github.com/isaacs/node-glob#glob-primer) and `Object`s with the following properties:\n\n| Property | Description                                                                                              | Default                              |\n| -------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| `path`   | **Required.** A [glob](https://github.com/isaacs/node-glob#glob-primer) to identify the files to upload. | -                                    |\n| `name`   | The name of the downloadable file on the GitHub release.                                                 | File name extracted from the `path`. |\n| `label`  | Short description of the file displayed on the GitHub release.                                           | -                                    |\n\nEach entry in the `assets` `Array` is globbed individually. A [glob](https://github.com/isaacs/node-glob#glob-primer)\ncan be a `String` (`\"dist/**/*.js\"` or `\"dist/mylib.js\"`) or an `Array` of `String`s that will be globbed together\n(`[\"dist/**\", \"!**/*.css\"]`).\n\nIf a directory is configured, all the files under this directory and its children will be included.\n\nThe `name` and `label` for each assets are generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                         |\n|---------------|-------------------------------------------------------------------------------------|\n| `branch`      | The branch from which the release is done.                                          |\n| `lastRelease` | `Object` with `version`, `gitTag` and `gitHead` of the last release.                |\n| `nextRelease` | `Object` with `version`, `gitTag`, `gitHead` and `notes` of the release being done. |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.  |\n\n**Note**: If a file has a match in `assets` it will be included even if it also has a match in `.gitignore`.\n\n##### assets examples\n\n`'dist/*.js'`: include all the `js` files in the `dist` directory, but not in its sub-directories.\n\n`[['dist', '!**/*.css']]`: include all the files in the `dist` directory and its sub-directories excluding the `css`\nfiles.\n\n`[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS distribution'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS\ndistribution'}]`: include the `dist/MyLibrary.js` and `dist/MyLibrary.css` files, and label them `MyLibrary JS\ndistribution` and `MyLibrary CSS distribution` in the GitHub release.\n\n`[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]`: include all the `js` and\n`css` files in the `dist` directory and its sub-directories excluding the minified version, plus the\n`build/MyLibrary.zip` file and label it `MyLibrary` in the GitHub release.\n\n`[{path: 'dist/MyLibrary.js', name: 'MyLibrary-${nextRelease.gitTag}.js', label: 'MyLibrary JS (${nextRelease.gitTag}) distribution'}]`: include the file `dist/MyLibrary.js` and upload it to the GitHub release with name `MyLibrary-v1.0.0.js` and label `MyLibrary JS (v1.0.0) distribution` which will generate the link:\n\n> `[MyLibrary JS (v1.0.0) distribution](MyLibrary-v1.0.0.js)`\n\n#### successComment\n\nThe message for the issue comments is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                                                                                                                                                                                                                   |\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`      | `Object` with `name`, `type`, `channel`, `range` and `prerelease` properties of the branch from which the release is done.                                                                                                                                                    |\n| `lastRelease` | `Object` with `version`, `channel`, `gitTag` and `gitHead` of the last release.                                                                                                                                                                                               |\n| `nextRelease` | `Object` with `version`, `channel`, `gitTag`, `gitHead` and `notes` of the release being done.                                                                                                                                                                                |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.                                                                                                                                                                                            |\n| `releases`    | `Array` with a release `Object`s for each release published, with optional release data such as `name` and `url`.                                                                                                                                                             |\n| `issue`       | A [GitHub API pull request object](https://developer.github.com/v3/search/#search-issues) for pull requests related to a commit, or an `Object` with the `number` property for issues resolved via [keywords](https://help.github.com/articles/closing-issues-using-keywords) |\n\n##### successComment example\n\nThe `successComment` `This ${issue.pull_request ? 'pull request' : 'issue'} is included in version ${nextRelease.version}` will generate the comment:\n\n> This pull request is included in version 1.0.0\n\n#### failComment\n\nThe message for the issue content is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter | Description                                                                                                                                                                                                                                                                                                            |\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`  | The branch from which the release had failed.                                                                                                                                                                                                                                                                          |\n| `errors`  | An `Array` of [SemanticReleaseError](https://github.com/semantic-release/error). Each error has the `message`, `code`, `pluginName` and `details` properties.<br>`pluginName` contains the package name of the plugin that threw the error.<br>`details` contains a information about the error formatted in markdown. |\n\n##### failComment example\n\nThe `failComment` `This release from branch ${branch.name} had failed due to the following errors:\\n- ${errors.map(err => err.message).join('\\\\n- ')}` will generate the comment:\n\n> This release from branch master had failed due to the following errors:\n> - Error message 1\n> - Error message 2\n\n#### releasedLabels\n\nEach label name is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                                                                                                                                                                                                                   |\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`      | `Object` with `name`, `type`, `channel`, `range` and `prerelease` properties of the branch from which the release is done.                                                                                                                                                    |\n| `lastRelease` | `Object` with `version`, `channel`, `gitTag` and `gitHead` of the last release.                                                                                                                                                                                               |\n| `nextRelease` | `Object` with `version`, `channel`, `gitTag`, `gitHead` and `notes` of the release being done.                                                                                                                                                                                |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.                                                                                                                                                                                            |\n| `releases`    | `Array` with a release `Object`s for each release published, with optional release data such as `name` and `url`.                                                                                                                                                             |\n| `issue`       | A [GitHub API pull request object](https://developer.github.com/v3/search/#search-issues) for pull requests related to a commit, or an `Object` with the `number` property for issues resolved via [keywords](https://help.github.com/articles/closing-issues-using-keywords) |\n\n##### releasedLabels example\n\nThe `releasedLabels` ```['released<%= nextRelease.channel ? ` on @\\${nextRelease.channel}` : \"\" %> from <%= branch.name %>']``` will generate the label:\n\n> released on @next from branch next\n","readmeFilename":"README.md","gitHead":"32654fb26dbba597170408ab181255ae863ed748","_id":"@antongolub/semantic-release-github@0.0.3-beta","_nodeVersion":"14.5.0","_npmVersion":"6.14.5","dist":{"integrity":"sha512-0wez4pxs/7e6mITvJBlZS7zf9FiJ9uxBvW8xpaf70+YzoeHJwHb8KFWMDCKuwsC1nKySR/ANX/Odpyb0QBND/g==","shasum":"0face2c610189573a4e037caa397bf639c2fa705","tarball":"https://registry.npmjs.org/@antongolub/semantic-release-github/-/semantic-release-github-0.0.3-beta.tgz","fileCount":22,"unpackedSize":62230,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIxU0CRA9TVsSAnZWagAAQGcP/jTU0Ax27GUrEGuc3smm\nhAVquxh86nYy4Gx7pR/Bek3nRwd6ynHXSSo0FZo43TODHqa2w7MtopQ3PvxC\nWV6+IlfdKch8NzdgqckZD/HSV/4StC87jUebBsHJyDcPRepz0CKBabjE1mc4\np8S3CBrxrR+bd7ro5JtMdy1LJ05QE3lI49CDy1wJ7ctk2wkFGM1N63X75drj\nCslwYZYW7H6Ky4np/DBlccyrAMFv6VMC6jYA5fP9nhJob9Bh613TmJXa1BxU\n1A96dVrfF9iU34iTDsGwPKgh0N27jmtKMI4j7fIZdj1ezv0v0DL2e8QXdnPq\nAXi9ofdDwK0mOB+qLV2vduPElwG2F+Ul+6KkIbJiURz+xX7RiIuisty+I3s4\ntDZ7iGoBOWcVHIwWhPQ0hd5MRsWBzgVOwzNJuNJN9l89sitQGyewZN9/emJK\nFkZStWR28Bzy8D/u03cUw4s68xcRETY19bBmeDou9sLi1pSEPMR+GCva51x2\nUryNNMJpIF/c5eRgmT5WqZt2z3Nbe5CvVD178FNmk4I17/ebuH+QafWnnPj0\n/Ip86Fff+pLcLYBpZNnlTI7WIFZMLUEWegHbi9RkO8birokeF8KDzHEEvz0D\np+BN/E8FGj1YbLMRj7+UyIRdbxAKBJf0dsWbGVRdEwi93y9ZKydF8BAC3FjT\ngyfR\r\n=NIXE\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDzJsHnguB3vX11MR9PUH9Lbros2KLObDjZSmoTuJXV8AIhAOdaLkvTUFaf68lMAqnUF068u6mAmOADq2RP4dR1iizb"}]},"maintainers":[{"name":"antongolub","email":"golub.anton@gmail.com"}],"_npmUser":{"name":"antongolub","email":"golub.anton@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-github_0.0.3-beta_1596134707614_0.27501907825278793"},"_hasShrinkwrap":false},"0.0.4-beta":{"name":"@antongolub/semantic-release-github","description":"semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues","version":"0.0.4-beta","private":false,"publishConfig":{"access":"public"},"author":{"name":"Pierre Vanduynslager","url":"https://twitter.com/@pvdlg_"},"ava":{"files":["test/**/*.test.js"]},"bugs":{"url":"https://github.com/semantic-release/github/issues"},"contributors":[{"name":"Stephan Bönnemann","email":"stephan@boennemann.me","url":"http://boennemann.me"},{"name":"Gregor Martynus","url":"https://twitter.com/gr2m"}],"dependencies":{"@octokit/rest":"^17.0.0","@semantic-release/error":"^2.2.0","aggregate-error":"^3.0.0","bottleneck":"^2.18.1","debug":"^4.0.0","dir-glob":"^3.0.0","fs-extra":"^9.0.0","globby":"^11.0.0","http-proxy-agent":"^4.0.0","https-proxy-agent":"^5.0.0","issue-parser":"^6.0.0","lodash":"^4.17.4","mime":"^2.4.3","p-filter":"^2.0.0","p-retry":"^4.0.0","url-join":"^4.0.0"},"devDependencies":{"ava":"^3.1.0","clear-module":"^4.0.0","codecov":"^3.5.0","nock":"^12.0.0","nyc":"^15.0.0","proxy":"^1.0.0","proxyquire":"^2.0.0","semantic-release":"^17.0.0","server-destroy":"^1.0.1","sinon":"^9.0.0","tempy":"^0.5.0","xo":"^0.30.0"},"engines":{"node":">=10.18"},"homepage":"https://github.com/semantic-release/github#readme","keywords":["git","github","issue","notifications","publish","pull-request","release","semantic-release","version"],"license":"MIT","main":"index.js","nyc":{"include":["lib/**/*.js","index.js"],"reporter":["json","text","html"],"all":true},"peerDependencies":{"semantic-release":">=16.0.0 <18.0.0"},"prettier":{"printWidth":120,"trailingComma":"es5"},"repository":{"type":"git","url":"git+https://github.com/semantic-release/github.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":{"camelcase":["error",{"properties":"never"}],"unicorn/string-content":"off"}},"readme":"# @semantic-release/github\n\n[**semantic-release**](https://github.com/semantic-release/semantic-release) plugin to publish a\n[GitHub release](https://help.github.com/articles/about-releases) and comment on released Pull Requests/Issues.\n\n[![Travis](https://img.shields.io/travis/semantic-release/github.svg)](https://travis-ci.org/semantic-release/github)\n[![Codecov](https://img.shields.io/codecov/c/github/semantic-release/github.svg)](https://codecov.io/gh/semantic-release/github)\n[![Greenkeeper badge](https://badges.greenkeeper.io/semantic-release/github.svg)](https://greenkeeper.io/)\n\n[![npm latest version](https://img.shields.io/npm/v/@semantic-release/github/latest.svg)](https://www.npmjs.com/package/@semantic-release/github)\n[![npm next version](https://img.shields.io/npm/v/@semantic-release/github/next.svg)](https://www.npmjs.com/package/@semantic-release/github)\n[![npm beta version](https://img.shields.io/npm/v/@semantic-release/github/beta.svg)](https://www.npmjs.com/package/@semantic-release/github)\n\n| Step               | Description                                                                                                                                                                                                                              |\n|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `verifyConditions` | Verify the presence and the validity of the authentication (set via [environment variables](#environment-variables)) and the [assets](#assets) option configuration.                                                                     |\n| `publish`          | Publish a [GitHub release](https://help.github.com/articles/about-releases), optionally uploading file assets.                                                                                                                           |\n| `addChannel`       | Update a [GitHub release](https://help.github.com/articles/about-releases)'s `pre-release` field.                                                                                                                                        |\n| `success`          | Add a comment to each [GitHub Issue](https://help.github.com/articles/about-issues) or [Pull Request](https://help.github.com/articles/about-pull-requests) resolved by the release and close issues previously open by the `fail` step. |\n| `fail`             | Open or update a [GitHub Issue](https://help.github.com/articles/about-issues) with information about the errors that caused the release to fail.                                                                                        |\n\n## Install\n\n```bash\n$ npm install @semantic-release/github -D\n```\n\n## Usage\n\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):\n\n```json\n{\n  \"plugins\": [\n    \"@semantic-release/commit-analyzer\",\n    \"@semantic-release/release-notes-generator\",\n    [\"@semantic-release/github\", {\n      \"assets\": [\n        {\"path\": \"dist/asset.min.css\", \"label\": \"CSS distribution\"},\n        {\"path\": \"dist/asset.min.js\", \"label\": \"JS distribution\"}\n      ]\n    }],\n  ]\n}\n```\n\nWith this example [GitHub releases](https://help.github.com/articles/about-releases) will be published with the file `dist/asset.min.css` and `dist/asset.min.js`.\n\n## Configuration\n\n### GitHub authentication\n\nThe GitHub authentication configuration is **required** and can be set via [environment variables](#environment-variables).\n\nFollow the [Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line) documentation to obtain an authentication token. The token has to be made available in your CI environment via the `GH_TOKEN` environment variable. The user associated with the token must have push permission to the repository.\n\nWhen creating the token, the **minimum required scopes** are:\n\n- [`repo`](https://github.com/settings/tokens/new?scopes=repo) for a private repository\n- [`public_repo`](https://github.com/settings/tokens/new?scopes=public_repo) for a public repository\n\n_Note on GitHub Actions:_ You can use the default token which is provided in  the secret _GITHUB_TOKEN_. However releases done with this token will NOT trigger release events to start other workflows.\nIf you have actions that trigger on newly created releases, please use a generated token for that and store it in your repository's secrets (any other name than GITHUB_TOKEN is fine).\n\n### Environment variables\n\n| Variable                                           | Description                                               |\n| -------------------------------------------------- | --------------------------------------------------------- |\n| `GH_TOKEN` or `GITHUB_TOKEN`                       | **Required.** The token used to authenticate with GitHub. |\n| `GITHUB_API_URL` or `GH_URL` or `GITHUB_URL`       | The GitHub Enterprise endpoint.                           |\n| `GH_PREFIX` or `GITHUB_PREFIX`                     | The GitHub Enterprise API prefix.                         |\n\n### Options\n\n| Option                | Description                                                                                                                                                                                            | Default                                                                                                                                              |\n|-----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `githubUrl`           | The GitHub Enterprise endpoint.                                                                                                                                                                        | `GH_URL` or `GITHUB_URL` environment variable.                                                                                                       |\n| `githubApiPathPrefix` | The GitHub Enterprise API prefix.                                                                                                                                                                      | `GH_PREFIX` or `GITHUB_PREFIX` environment variable.                                                                                                 |\n| `proxy`               | The proxy to use to access the GitHub API. See [proxy](#proxy).                                                                                                                                        | `HTTP_PROXY` environment variable.                                                                                                                   |\n| `assets`              | An array of files to upload to the release. See [assets](#assets).                                                                                                                                     | -                                                                                                                                                    |\n| `successComment`      | The comment to add to each issue and pull request resolved by the release. Set to `false` to disable commenting on issues and pull requests. See [successComment](#successcomment).                    | `:tada: This issue has been resolved in version ${nextRelease.version} :tada:\\n\\nThe release is available on [GitHub release](<github_release_url>)` |\n| `failComment`         | The content of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails. See [failComment](#failcomment).                                               | Friendly message with links to **semantic-release** documentation and support, with the list of errors that caused the release to fail.              |\n| `failTitle`           | The title of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails.                                                                                  | `The automated release is failing 🚨`                                                                                                                |\n| `labels`              | The [labels](https://help.github.com/articles/about-labels) to add to the issue created when a release fails. Set to `false` to not add any label.                                                     | `['semantic-release']`                                                                                                                               |\n| `assignees`           | The [assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users) to add to the issue created when a release fails.                                           | -                                                                                                                                                    |\n| `releasedLabels`      | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \\` on @\\${nextRelease.channel}\\` : \"\" %>']`                                                                     |\n\n#### proxy\n\nCan be a the proxy URL or and `Object` with the following properties:\n\n| Property      | Description                                                    | Default                              |\n|---------------|----------------------------------------------------------------|--------------------------------------|\n| `host`        | **Required.** Proxy host to connect to.                        | -                                    |\n| `port`        | **Required.** Proxy port to connect to.                        | File name extracted from the `path`. |\n| `secureProxy` | If `true`, then use TLS to connect to the proxy.               | `false`                              |\n| `headers`     | Additional HTTP headers to be sent on the HTTP CONNECT method. | -                                    |\n\nSee [node-https-proxy-agent](https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options) and [node-http-proxy-agent](https://github.com/TooTallNate/node-http-proxy-agent) for additional details.\n\n##### proxy examples\n\n`'http://168.63.76.32:3128'`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request.\n`{host: '168.63.76.32', port: 3128, headers: {Foo: 'bar'}}`: use the proxy running on host `168.63.76.32` and port `3128` for each GitHub API request, setting the `Foo` header value to `bar`.\n\n#### assets\n\nCan be a [glob](https://github.com/isaacs/node-glob#glob-primer) or and `Array` of\n[globs](https://github.com/isaacs/node-glob#glob-primer) and `Object`s with the following properties:\n\n| Property | Description                                                                                              | Default                              |\n| -------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| `path`   | **Required.** A [glob](https://github.com/isaacs/node-glob#glob-primer) to identify the files to upload. | -                                    |\n| `name`   | The name of the downloadable file on the GitHub release.                                                 | File name extracted from the `path`. |\n| `label`  | Short description of the file displayed on the GitHub release.                                           | -                                    |\n\nEach entry in the `assets` `Array` is globbed individually. A [glob](https://github.com/isaacs/node-glob#glob-primer)\ncan be a `String` (`\"dist/**/*.js\"` or `\"dist/mylib.js\"`) or an `Array` of `String`s that will be globbed together\n(`[\"dist/**\", \"!**/*.css\"]`).\n\nIf a directory is configured, all the files under this directory and its children will be included.\n\nThe `name` and `label` for each assets are generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                         |\n|---------------|-------------------------------------------------------------------------------------|\n| `branch`      | The branch from which the release is done.                                          |\n| `lastRelease` | `Object` with `version`, `gitTag` and `gitHead` of the last release.                |\n| `nextRelease` | `Object` with `version`, `gitTag`, `gitHead` and `notes` of the release being done. |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.  |\n\n**Note**: If a file has a match in `assets` it will be included even if it also has a match in `.gitignore`.\n\n##### assets examples\n\n`'dist/*.js'`: include all the `js` files in the `dist` directory, but not in its sub-directories.\n\n`[['dist', '!**/*.css']]`: include all the files in the `dist` directory and its sub-directories excluding the `css`\nfiles.\n\n`[{path: 'dist/MyLibrary.js', label: 'MyLibrary JS distribution'}, {path: 'dist/MyLibrary.css', label: 'MyLibrary CSS\ndistribution'}]`: include the `dist/MyLibrary.js` and `dist/MyLibrary.css` files, and label them `MyLibrary JS\ndistribution` and `MyLibrary CSS distribution` in the GitHub release.\n\n`[['dist/**/*.{js,css}', '!**/*.min.*'], {path: 'build/MyLibrary.zip', label: 'MyLibrary'}]`: include all the `js` and\n`css` files in the `dist` directory and its sub-directories excluding the minified version, plus the\n`build/MyLibrary.zip` file and label it `MyLibrary` in the GitHub release.\n\n`[{path: 'dist/MyLibrary.js', name: 'MyLibrary-${nextRelease.gitTag}.js', label: 'MyLibrary JS (${nextRelease.gitTag}) distribution'}]`: include the file `dist/MyLibrary.js` and upload it to the GitHub release with name `MyLibrary-v1.0.0.js` and label `MyLibrary JS (v1.0.0) distribution` which will generate the link:\n\n> `[MyLibrary JS (v1.0.0) distribution](MyLibrary-v1.0.0.js)`\n\n#### successComment\n\nThe message for the issue comments is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                                                                                                                                                                                                                   |\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`      | `Object` with `name`, `type`, `channel`, `range` and `prerelease` properties of the branch from which the release is done.                                                                                                                                                    |\n| `lastRelease` | `Object` with `version`, `channel`, `gitTag` and `gitHead` of the last release.                                                                                                                                                                                               |\n| `nextRelease` | `Object` with `version`, `channel`, `gitTag`, `gitHead` and `notes` of the release being done.                                                                                                                                                                                |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.                                                                                                                                                                                            |\n| `releases`    | `Array` with a release `Object`s for each release published, with optional release data such as `name` and `url`.                                                                                                                                                             |\n| `issue`       | A [GitHub API pull request object](https://developer.github.com/v3/search/#search-issues) for pull requests related to a commit, or an `Object` with the `number` property for issues resolved via [keywords](https://help.github.com/articles/closing-issues-using-keywords) |\n\n##### successComment example\n\nThe `successComment` `This ${issue.pull_request ? 'pull request' : 'issue'} is included in version ${nextRelease.version}` will generate the comment:\n\n> This pull request is included in version 1.0.0\n\n#### failComment\n\nThe message for the issue content is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter | Description                                                                                                                                                                                                                                                                                                            |\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`  | The branch from which the release had failed.                                                                                                                                                                                                                                                                          |\n| `errors`  | An `Array` of [SemanticReleaseError](https://github.com/semantic-release/error). Each error has the `message`, `code`, `pluginName` and `details` properties.<br>`pluginName` contains the package name of the plugin that threw the error.<br>`details` contains a information about the error formatted in markdown. |\n\n##### failComment example\n\nThe `failComment` `This release from branch ${branch.name} had failed due to the following errors:\\n- ${errors.map(err => err.message).join('\\\\n- ')}` will generate the comment:\n\n> This release from branch master had failed due to the following errors:\n> - Error message 1\n> - Error message 2\n\n#### releasedLabels\n\nEach label name is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:\n\n| Parameter     | Description                                                                                                                                                                                                                                                                   |\n|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `branch`      | `Object` with `name`, `type`, `channel`, `range` and `prerelease` properties of the branch from which the release is done.                                                                                                                                                    |\n| `lastRelease` | `Object` with `version`, `channel`, `gitTag` and `gitHead` of the last release.                                                                                                                                                                                               |\n| `nextRelease` | `Object` with `version`, `channel`, `gitTag`, `gitHead` and `notes` of the release being done.                                                                                                                                                                                |\n| `commits`     | `Array` of commit `Object`s with `hash`, `subject`, `body` `message` and `author`.                                                                                                                                                                                            |\n| `releases`    | `Array` with a release `Object`s for each release published, with optional release data such as `name` and `url`.                                                                                                                                                             |\n| `issue`       | A [GitHub API pull request object](https://developer.github.com/v3/search/#search-issues) for pull requests related to a commit, or an `Object` with the `number` property for issues resolved via [keywords](https://help.github.com/articles/closing-issues-using-keywords) |\n\n##### releasedLabels example\n\nThe `releasedLabels` ```['released<%= nextRelease.channel ? ` on @\\${nextRelease.channel}` : \"\" %> from <%= branch.name %>']``` will generate the label:\n\n> released on @next from branch next\n","readmeFilename":"README.md","gitHead":"32654fb26dbba597170408ab181255ae863ed748","_id":"@antongolub/semantic-release-github@0.0.4-beta","_nodeVersion":"14.5.0","_npmVersion":"6.14.5","dist":{"integrity":"sha512-qbfKYAagtYGHIq2mDzW56eNgBoK1CFowXdFzQpLfb9NCTWvVpYJPDFWmdqJIGyrLVjKfR+E40Pq/VXx/9Cd8pQ==","shasum":"0492174141d18e0de66c8863ce49b4f3497c6f4b","tarball":"https://registry.npmjs.org/@antongolub/semantic-release-github/-/semantic-release-github-0.0.4-beta.tgz","fileCount":22,"unpackedSize":62230,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIyloCRA9TVsSAnZWagAAkA0P/RqbJeFnGxbvitCvjEUz\ndimZOOUSJO6Hqpyty2F+mTeYdxbA3x60qNB+xKEYu4t1+YOT+kMCVfMlk0CV\n29iZBCb2JNTy4dkgS6B1mDTrCBUqAH3xEZ7JFDMgF0zSz4KbCS2V62YLBA1k\njkpzllVhuokTWYBs/yQmIdIeEGnnxNM1n60uv8OX3PAmeJZYylLa5gEjj6Y/\nZi00l7i+ZodbP1Px2SFK+qMmcN0qjevdMomBBi3B6SamKJitjCVDtQtsEcvK\nvOG0RgQMMj70tkmS/kXveV9ELFaP9AjwPD/15V2fttakObCZ5jU64OrYwANh\n9Ide1D2yJ9xtWlyVtQs0RmeJ32Nh+BygGBlT+TDrytWS95vKK3U0OioQtZY7\nOt59KxiVsjhA7lPJeqZUjfAB6fcVTyb9+G4MGaiQ+iQb9nJYs3OZ2uY91U7p\nyxmRZCwO87VdAU1oPI7QNkthy0y6BWc1toALliLgS21ZoYfn02CcDwhjt8Uy\nj+6SFMO59cHky+iVqNERKcWHRwZI+uXQcLrTAMSedcWzS3E3wSP5q6Qp2EFx\n2SX+1sMAd7YhhJJ2OSBzL/TcWzegdSGM1x/vIRr5dVyEuDhKgsxp28S6pSdj\n/9X+C7FZTAEMKMfvkOT4d8SfTLpvwo85kd6s9oOfOdyKu8ueVqwOCPHzZdSN\nC5wi\r\n=nNlU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHU+DRv+ZMZrI9e0rqojMtWZ9J4s8IZGnoVzRIi+83B+AiBoZz8ItrTkubr2hQGXHREvj/cCE/ZHK4R8gOV7tMNOHg=="}]},"maintainers":[{"name":"antongolub","email":"golub.anton@gmail.com"}],"_npmUser":{"name":"antongolub","email":"golub.anton@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-github_0.0.4-beta_1596139880224_0.6219499260658383"},"_hasShrinkwrap":false}},"time":{"created":"2020-07-30T17:00:19.960Z","0.0.1-beta":"2020-07-30T17:00:20.129Z","modified":"2022-04-04T14:23:13.979Z","0.0.2-beta":"2020-07-30T17:07:07.274Z","0.0.3-beta":"2020-07-30T18:45:07.750Z","0.0.4-beta":"2020-07-30T20:11:20.402Z"},"maintainers":[{"name":"antongolub","email":"golub.anton@gmail.com"}],"description":"semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues","homepage":"https://github.com/semantic-release/github#readme","keywords":["git","github","issue","notifications","publish","pull-request","release","semantic-release","version"],"repository":{"type":"git","url":"git+https://github.com/semantic-release/github.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/github/issues"},"license":"MIT","readme":"","readmeFilename":""}