{"_id":"@achingbrain/semantic-release-github","_rev":"2-f0d4b7e1a2fca927ab859af80e3f0ed9","name":"@achingbrain/semantic-release-github","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.0":{"name":"@achingbrain/semantic-release-github","description":"semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues","version":"0.0.0","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/plugin-retry":"^3.0.9","@octokit/plugin-throttling":"^3.6.2","@octokit/rest":"^18.0.0","@semantic-release/error":"^2.2.0","aggregate-error":"^3.0.0","debug":"^4.0.0","dir-glob":"^3.0.0","fs-extra":"^10.0.0","globby":"^11.0.0","http-proxy-agent":"^5.0.0","https-proxy-agent":"^5.0.0","issue-parser":"^6.0.0","lodash":"^4.17.4","mime":"^3.0.0","p-filter":"^2.0.0","url-join":"^4.0.0"},"devDependencies":{"ava":"4.1.0","clear-module":"4.1.2","codecov":"3.8.3","nock":"13.2.4","nyc":"15.1.0","proxy":"1.0.2","proxyquire":"2.1.3","semantic-release":"19.0.2","server-destroy":"1.0.1","sinon":"13.0.1","tempy":"1.0.1","xo":"0.36.1"},"engines":{"node":">=14.17"},"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":">=18.0.0-beta.1"},"prettier":{"printWidth":120,"trailingComma":"es5"},"publishConfig":{"access":"public"},"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","test:ci":"nyc ava -v"},"xo":{"prettier":true,"space":true,"rules":{"camelcase":["error",{"properties":"never"}],"unicorn/string-content":"off","unicorn/no-reduce":"off"}},"renovate":{"extends":["github>semantic-release/.github"]},"gitHead":"fa3e386f3033173effe47c1de225a75c6d62faa3","_id":"@achingbrain/semantic-release-github@0.0.0","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-HES6WrXTaPpIvsABCn3aM12AjqgV6aEPDMw8oaXGD702T6ZqQ98dQGlq1wt3IzX2yBQbNcFrwK8eVC0M1nz4uw==","shasum":"c2750e4c49778cca70bd5687567ee21fb005a114","tarball":"https://registry.npmjs.org/@achingbrain/semantic-release-github/-/semantic-release-github-0.0.0.tgz","fileCount":24,"unpackedSize":63851,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCID0vuo2FMlnlTZ7QGfDh3AIy7HeaiOpJBIh3ngNyN5uQAiEA/KALB2yJkujtYMuczT3Ea2x3eo0ThS+KJEoXds74DLQ="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiUCOmACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqT2g/9Hyd5al+rjkSlgTgXTIhPp419bBTeViqRPOvNxTwA8s4NB9ik\r\nK3SyO+aSu8gXIyua3SBCUFN+TWT6vfxg3Er5U6JQv246IzRzMJqML3evq2KY\r\n+NzyRycoIXZ4Vz7snNaBek7SYetc0Jp/VatkdyR579Bwnd+4pZSpWxFITcxF\r\n/Zf8EhfQUEk4RWYnhaUaBkwU7qXyUwS1Hrc+cixdgykgeQeWWzOJDiml5d6e\r\nRVbXE04mgRXgmwgM38K/PbilHrZAbzy3XMAMQzFinwn/w5PkNf0wihfKAbL2\r\nHSWaoSLl3hLYzZ6Pal3qQNWyXiFeKYsx14UOvo7MKxcwmcfKUTZCbrCt/urr\r\naNEgNmSCsgv8YcO9xWePhKaQP7paWb8QxN6BA0ZbDRQR3mApvoqsxJM8mY3S\r\nitD8eNaQ6ewI3NTa4iyA0xTRbdDDPUtZFsGOpw2DkPmngazHVDHX+GihclQb\r\n8HqGreYWn49Mw/l6fkSn8m5u+c3LyO/6D5NqXddarA8FBcqA2nGsjRpChmaK\r\ned3+zDDRjBbTGMYFGUXxanIvdJgQZXhVLgwD7PIurxOrZZ5CkBgpbauZfP1r\r\nei/LEBLaj3bPAb+tYyoq3vO6VH1KPsGBfN5jRUTY3+Z8rIN4X2WffMWAuAHI\r\nr6YwQ4qPhu4mIXlHZmw86ATos4vqAkbebxs=\r\n=Ma73\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-github_0.0.0_1649419173860_0.19088764306705475"},"_hasShrinkwrap":false},"0.0.1":{"name":"@achingbrain/semantic-release-github","description":"semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues","version":"0.0.1","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/plugin-retry":"^3.0.9","@octokit/plugin-throttling":"^3.6.2","@octokit/rest":"^19.0.0","@semantic-release/error":"^3.0.0","aggregate-error":"^3.0.0","debug":"^4.0.0","dir-glob":"^3.0.0","fs-extra":"^11.0.0","globby":"^11.0.0","http-proxy-agent":"^5.0.0","https-proxy-agent":"^5.0.0","issue-parser":"^6.0.0","lodash":"^4.17.4","mime":"^3.0.0","p-filter":"^2.0.0","url-join":"^4.0.0"},"devDependencies":{"ava":"5.1.0","clear-module":"4.1.2","codecov":"3.8.3","nock":"13.2.9","nyc":"15.1.0","proxy":"1.0.2","proxyquire":"2.1.3","semantic-release":"19.0.5","server-destroy":"1.0.1","sinon":"15.0.0","tempy":"1.0.1","xo":"0.36.1"},"engines":{"node":">=14.17"},"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":">=18.0.0-beta.1"},"prettier":{"printWidth":120,"trailingComma":"es5"},"publishConfig":{"access":"public"},"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","test:ci":"nyc ava -v"},"xo":{"prettier":true,"space":true,"rules":{"camelcase":["error",{"properties":"never"}],"unicorn/string-content":"off","unicorn/no-reduce":"off"}},"renovate":{"extends":["github>semantic-release/.github"]},"gitHead":"05ba949dba572ee0ea241c72c382f9100561de03","_id":"@achingbrain/semantic-release-github@0.0.1","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-6YUuIzAy0wObc9uUdYv7A13mHrKywTPIKcWWWZPsmBuIplfumi3UQk3DJKLb4Ex2iW260mIJjGaUF1gFs+nDnw==","shasum":"59a39a19df1573a9cfc352a34dff5bb93733d69e","tarball":"https://registry.npmjs.org/@achingbrain/semantic-release-github/-/semantic-release-github-0.0.1.tgz","fileCount":24,"unpackedSize":63851,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCHLzjG9EB637+kQNNw4TWzXtSQ3l8p6VFFFepc3IIaMwIhALNbImeM45jBxW5j2thv9h2S/cnIE7QU9gMt3EGfSm9x"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjmfMVACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrw9g/+KJvTW5K+uEJ8v3EYVDNTo3PNpKacdiaEI38I5CsnUYYWBW9E\r\n0s2XrYcfDa1tbBJFrjR3KY45IVezA6/MZz3AHCYnrDjz+Bf/JGA1rRAoFHjo\r\n8QAWARgPfHYbe8WVvs7bKJxN4EK+ZfUbm8piY96+9RhM+C/iWJMiSTl9WcOl\r\nKz28AVgSeYevYLSb+v4dFcp/KhmgAgnrSQ+J7zbq3XgvTIa15NjP5YkQBDyk\r\nPpTj+/YKXKSOiaVlvKsLRMO9OZ7UPP0A0jHAi63xtvcrKD2UF6pzaw9WuRqg\r\nEzoNJT+XhjXDnuLijqigA2S7pdt+q8rUHjem28dxqX6NdO2VhwXzrkjH4j7w\r\nXcCDT9qY5EFgRcrsJ7NxC4KpN18XuL/Jif9I4mSFo9E8u0qALh/pbkD1p2oS\r\ngNXjb5IKfJV6bv+QhhZPnQAFJkLkMdStTWglTBI24ZzxL863mIfCgcYs6Fzt\r\n1EpfsVUtL71V21slZE8ZGWBN0VDX3AJ4ksQkF5BNNbGdfthAkt5QW9bmZt7J\r\nmnpm76XXvuMc6JjvF7ZG+/0Mk9LRWC1QD2ZkLYKjT/JSiF6DiMh7me4J1pDl\r\nZ2p4GdsuAK5vRaG458+Am6CUGPgn1d4XD9l8pTWVXtfeD+iN51qfwuLHy7aM\r\nMGSyBc/WCjdOnc87bFV1FQE4wy5QRPh/NqQ=\r\n=gfI2\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-github_0.0.1_1671033621616_0.02428128850139699"},"_hasShrinkwrap":false},"0.0.2":{"name":"@achingbrain/semantic-release-github","description":"semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues","version":"0.0.2","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/plugin-retry":"^3.0.9","@octokit/plugin-throttling":"^3.6.2","@octokit/rest":"^19.0.0","@semantic-release/error":"^3.0.0","aggregate-error":"^3.0.0","debug":"^4.0.0","dir-glob":"^3.0.0","fs-extra":"^11.0.0","globby":"^11.0.0","http-proxy-agent":"^5.0.0","https-proxy-agent":"^5.0.0","issue-parser":"^6.0.0","lodash":"^4.17.4","mime":"^3.0.0","p-filter":"^2.0.0","url-join":"^4.0.0"},"devDependencies":{"ava":"5.1.0","clear-module":"4.1.2","codecov":"3.8.3","nock":"13.2.9","nyc":"15.1.0","proxy":"1.0.2","proxyquire":"2.1.3","semantic-release":"19.0.5","server-destroy":"1.0.1","sinon":"15.0.1","tempy":"1.0.1","xo":"0.36.1"},"engines":{"node":">=14.17"},"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":">=18.0.0-beta.1"},"prettier":{"printWidth":120,"trailingComma":"es5"},"publishConfig":{"access":"public"},"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","test:ci":"nyc ava -v"},"xo":{"prettier":true,"space":true,"rules":{"camelcase":["error",{"properties":"never"}],"unicorn/string-content":"off","unicorn/no-reduce":"off"}},"renovate":{"extends":["github>semantic-release/.github"]},"gitHead":"fe079758317b0c50c7175ec80cd9eb49699643f6","_id":"@achingbrain/semantic-release-github@0.0.2","_nodeVersion":"18.0.0","_npmVersion":"8.6.0","dist":{"integrity":"sha512-RTw6rXoFTTnVgyFCBkqEoM1I+WOi4dszMdVABN4gvbwdVqmKkW5/SignHYb/O8ONAHH0NlUCgxTYciCzg9RiLQ==","shasum":"1391d5a4b88629704409c684fa7eb6e35ae4cd1d","tarball":"https://registry.npmjs.org/@achingbrain/semantic-release-github/-/semantic-release-github-0.0.2.tgz","fileCount":24,"unpackedSize":63894,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGQbRanofn3TC4nJfD4g8kUG+7ian9YRdgKJ68Oiiqr5AiEAoZZz4CHXRUv8QDhGRy+lXSzx76GZ0ut5ZkK5HVEiOaM="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkUjrWACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmocGA/9Hk/qqs5gFh/9N3OktzlwyfvQXdivvNuUp+su/6yjafU3/rHO\r\nY7VN0m7AwEk6N6vY6TpAPe4Oz87YtSZ84qdV84ylf51VhR0K5qLffZjxw7Z1\r\nxo9ntOp/cidAgv1v++4wjX7V59ZW0mYxbm2bxgXYOkXbev1pYmKTjQoGwz2+\r\nJPRYPU8bpanl+APp17HEsxmnUjxfDAoJ5evcwXTn7bP8Hr6FLiov3OwkpRIR\r\nZPfBubO2wEYmn/CkdvL/3u5n+iFbaCwzAMXj8Qo5rgwXnCITAbM3VqnUl2MS\r\naBOib5+dKuPK/O/inow21vWieJrpeu9cxjJbHwLN162GxVhG7+G4g8/kugH6\r\nTuWp+SMcccanMGnN3aw4g7oSpbHzjppt43HJhTP5QhwTarc+f6I7J68EP9lq\r\n1O2fX+/6N+DThwoCE+VZ2GGTRfGcsmH96Gt0AEXnUagQXGrI5adalt7TgGJK\r\nM1aBTh62C9OIBQmx9hpouoKe5sN1VKAw/TLfip5LR50Oa6qOCVEYni3o6IV6\r\nPtrRNiiYxDIlr441LCKWinJ+yYIGZF6g40QNxu4e2U778V87XtuZxeGjrGmz\r\ni4XFF3cbNcbRVnJZtyZV1Vv7le9xhaDtz6sT9or6eIxxT59RXesmp7ljOV3W\r\nMQQ5DoHHMnevieWDPMLkmeoDaWUhWDE+xrc=\r\n=p7cF\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"directories":{},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/semantic-release-github_0.0.2_1683110614050_0.5328068666221617"},"_hasShrinkwrap":false}},"time":{"created":"2022-04-08T11:59:33.810Z","0.0.0":"2022-04-08T11:59:34.012Z","modified":"2023-05-03T10:43:34.339Z","0.0.1":"2022-12-14T16:00:21.781Z","0.0.2":"2023-05-03T10:43:34.219Z"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"}],"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":"# @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[![Build Status](https://github.com/semantic-release/github/workflows/Test/badge.svg)](https://github.com/semantic-release/github/actions?query=workflow%3ATest+branch%3Amaster)\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_Notes 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\nWhen using the _GITHUB_TOKEN_, the **minimum required permissions** are:\n\n- `contents: write` to be able to publish a GitHub release\n- `issues: write` to be able to comment on released issues\n- `pull-requests: write` to be able to comment on released pull requests\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. Set to `false` to disable usage of proxy. 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| `addReleases`         | Will add release links to the GitHub Release. Can be `false`, `\"bottom\"` or `\"top\"`. See [addReleases](#addReleases). | `false`                                                                     |\n\n#### proxy\n\nCan be `false`, a proxy URL or an `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\n#### addReleases\n\nAdd links to other releases to the GitHub release body.\n\nValid values for this option are `false`, `\"top\"` or `\"bottom\"`.\n\n##### addReleases example\n\nSee [The introducing PR](https://github.com/semantic-release/github/pull/282) for an example on how it will look.","readmeFilename":"README.md"}