{"id":22300433,"url":"https://github.com/professormanhattan/semantic-release-gh","last_synced_at":"2026-04-16T14:09:50.390Z","repository":{"id":44337876,"uuid":"454257375","full_name":"ProfessorManhattan/semantic-release-gh","owner":"ProfessorManhattan","description":"The official GitHub plugin, modified to accept repositoryUrl as a parameter 🐴","archived":false,"fork":false,"pushed_at":"2023-03-23T13:04:12.000Z","size":7442,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-06T16:00:55.651Z","etag":null,"topics":["git","github","issue","mblabs","megabytelabs","notifications","plugin","professormanhattan","publish","pull-request","release","semantic-release","version","washingtondc"],"latest_commit_sha":null,"homepage":"https://megabyte.space","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ProfessorManhattan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"docs/CODEOWNERS","security":null,"support":null,"governance":null},"funding":{"github":"ProfessorManhattan","open_collective":"megabytelabs","patreon":"ProfessorManhattan","custom":["donate.givedirectly.org"]}},"created_at":"2022-02-01T04:10:38.000Z","updated_at":"2023-08-18T18:13:09.000Z","dependencies_parsed_at":"2023-08-29T20:39:26.641Z","dependency_job_id":null,"html_url":"https://github.com/ProfessorManhattan/semantic-release-gh","commit_stats":null,"previous_names":["megabyte-labs/semantic-release-gh"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/ProfessorManhattan/semantic-release-gh","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessorManhattan%2Fsemantic-release-gh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessorManhattan%2Fsemantic-release-gh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessorManhattan%2Fsemantic-release-gh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessorManhattan%2Fsemantic-release-gh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ProfessorManhattan","download_url":"https://codeload.github.com/ProfessorManhattan/semantic-release-gh/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ProfessorManhattan%2Fsemantic-release-gh/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31889118,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-16T11:36:10.202Z","status":"ssl_error","status_checked_at":"2026-04-16T11:36:09.652Z","response_time":69,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git","github","issue","mblabs","megabytelabs","notifications","plugin","professormanhattan","publish","pull-request","release","semantic-release","version","washingtondc"],"created_at":"2024-12-03T18:10:56.117Z","updated_at":"2026-04-16T14:09:50.373Z","avatar_url":"https://github.com/ProfessorManhattan.png","language":"JavaScript","funding_links":["https://github.com/sponsors/ProfessorManhattan","https://opencollective.com/megabytelabs","https://patreon.com/ProfessorManhattan","donate.givedirectly.org","https://www.patreon.com/ProfessorManhattan"],"categories":[],"sub_categories":[],"readme":"\u003c!-- ⚠️ This README has been generated from the file(s) \".config/docs/blueprint-readme-plugin.md\" ⚠️--\u003e\u003cdiv align=\"center\"\u003e\n  \u003ccenter\u003e\n    \u003ca href=\"https://github.com/megabyte-labs/semantic-release-gh\"\u003e\n      \u003cimg width=\"148\" height=\"148\" alt=\"Semantic Release GitHub logo\" src=\"https://gitlab.com/megabyte-labs/npm/plugin/semantic-release-gh/-/raw/master/logo.png\" /\u003e\n    \u003c/a\u003e\n  \u003c/center\u003e\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ccenter\u003e\u003ch1 align=\"center\"\u003e\u003ci\u003e\u003c/i\u003eSemantic Release GitHub\u003ci\u003e\u003c/i\u003e\u003c/h1\u003e\u003c/center\u003e\n  \u003ccenter\u003e\u003ch4 style=\"color: #18c3d1;\"\u003eA plugin created by \u003ca href=\"https://megabyte.space\" target=\"_blank\"\u003eMegabyte Labs\u003c/a\u003e\u003c/h4\u003e\u003ci\u003e\u003c/i\u003e\u003c/center\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://megabyte.space\" title=\"Megabyte Labs homepage\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Homepage\" src=\"https://img.shields.io/website?down_color=%23FF4136\u0026down_message=Down\u0026label=Homepage\u0026logo=home-assistant\u0026logoColor=white\u0026up_color=%232ECC40\u0026up_message=Up\u0026url=https%3A%2F%2Fmegabyte.space\u0026style=for-the-badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/megabyte-labs/semantic-release-gh/blob/master/docs/CONTRIBUTING.md\" title=\"Learn about contributing\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Contributing\" src=\"https://img.shields.io/badge/Contributing-Guide-0074D9?logo=github-sponsors\u0026logoColor=white\u0026style=for-the-badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://app.slack.com/client/T01ABCG4NK1/C01NN74H0LW/details/\" title=\"Chat with us on Slack\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Slack\" src=\"https://img.shields.io/badge/Slack-Chat-e01e5a?logo=slack\u0026logoColor=white\u0026style=for-the-badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitter.im/megabyte-labs/community\" title=\"Chat with the community on Gitter\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Gitter\" src=\"https://img.shields.io/gitter/room/megabyte-labs/community?logo=gitter\u0026logoColor=white\u0026style=for-the-badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/megabyte-labs/semantic-release-gh\" title=\"GitHub mirror\" target=\"_blank\"\u003e\n    \u003cimg alt=\"GitHub\" src=\"https://img.shields.io/badge/Mirror-GitHub-333333?logo=github\u0026style=for-the-badge\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitlab.com/megabyte-labs/npm/plugin/semantic-release-gh\" title=\"GitLab repository\" target=\"_blank\"\u003e\n    \u003cimg alt=\"GitLab\" src=\"https://img.shields.io/badge/Repo-GitLab-fc6d26?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgAQMAAABJtOi3AAAABlBMVEUAAAD///+l2Z/dAAAAAXRSTlMAQObYZgAAAHJJREFUCNdNxKENwzAQQNEfWU1ZPUF1cxR5lYxQqQMkLEsUdIxCM7PMkMgLGB6wopxkYvAeI0xdHkqXgCLL0Beiqy2CmUIdeYs+WioqVF9C6/RlZvblRNZD8etRuKe843KKkBPw2azX13r+rdvPctEaFi4NVzAN2FhJMQAAAABJRU5ErkJggg==\u0026style=for-the-badge\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cbr/\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/semantic-release-gh\" title=\"Version 1.0.29\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Version: 1.0.29\" src=\"https://img.shields.io/badge/version-1.0.29-blue.svg?cacheSeconds=2592000\u0026logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgAQMAAABJtOi3AAAABlBMVEUAAAD///+l2Z/dAAAAAXRSTlMAQObYZgAAACNJREFUCNdjIACY//+BEp9hhM3hAzYQwoBIAqEDYQrCZLwAAGlFKxU1nF9cAAAAAElFTkSuQmCC\u0026style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://gitlab.com/megabyte-labs/npm/plugin/semantic-release-gh/-/commits/master\" title=\"GitLab CI build status\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Build status\" src=\"https://img.shields.io/gitlab/pipeline-status/megabyte-labs/npm/plugin/semantic-release-gh?branch=master\u0026label=build\u0026logo=gitlab\u0026logoColor=white\u0026style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/semantic-release-gh\" title=\"Dependency status reported by Depfu\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Dependency status reported by Depfu\" src=\"https://img.shields.io/depfu/megabyte-labs/semantic-release-gh?logo=codeforces\u0026logoColor=white\u0026style=flat-square\u0026logo=npm\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/semantic-release-gh\" title=\"Zip file size\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Zip file size\" src=\"https://img.shields.io/bundlephobia/minzip/semantic-release-gh?style=flat-square\u0026logo=npm\u0026logoColor=white\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/semantic-release-gh\" title=\"Total downloads of semantic-release-gh on npmjs.org\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Total downloads of semantic-release-gh on npmjs.org\" src=\"https://img.shields.io/npm/dt/semantic-release-gh?style=flat-square\u0026logo=npm\u0026logoColor=white\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://snyk.io/advisor/npm-package/semantic-release-gh\" title=\"Number of vulnerabilities from Snyk scan on semantic-release-gh\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Number of vulnerabilities from Snyk scan on semantic-release-gh\" src=\"https://img.shields.io/snyk/vulnerabilities/npm/semantic-release-gh?style=flat-square\u0026logo=snyk\u0026logoColor=white\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"website.documentation/npm\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Documentation\" src=\"https://img.shields.io/badge/documentation-yes-brightgreen.svg?logo=readthedocs\u0026logoColor=white\u0026style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/megabyte-labs/semantic-release-gh/blob/master/LICENSE\" target=\"_blank\"\u003e\n    \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/badge/license-MIT-yellow.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgAQMAAABJtOi3AAAABlBMVEUAAAD///+l2Z/dAAAAAXRSTlMAQObYZgAAAHpJREFUCNdjYOD/wMDAUP+PgYHxhzwDA/MB5gMM7AwMDxj4GBgKGGQYGCyAEEgbMDDwAAWAwmk8958xpIOI5zKH2RmOyhxmZjguAiKmgIgtQOIYmFgCIp4AlaQ9OczGkJYCJEAGgI0CGwo2HmwR2Eqw5SBnNIAdBHYaAJb6KLM15W/CAAAAAElFTkSuQmCC\u0026style=flat-square\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003e \u003cbr/\u003e\u003ch4 align=\"center\"\u003e**The official GitHub plugin, modified to accept repositoryUrl as a parameter**\u003c/h4\u003e\u003cbr/\u003e\n\n\u003ca href=\"#table-of-contents\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Requirements](#requirements)\n  - [Developer Requirements](#developer-requirements)\n- [Summary](#summary)\n- [Install](#install)\n- [Usage](#usage)\n- [Configuration](#configuration)\n  - [GitHub authentication](#github-authentication)\n  - [Environment variables](#environment-variables)\n  - [Options](#options)\n    - [`proxy`](#proxy)\n    - [`proxy` Examples](#proxy-examples)\n    - [`assets`](#assets)\n    - [`assets` Examples](#assets-examples)\n    - [`successComment`](#successcomment)\n    - [`successComment` Example](#successcomment-example)\n    - [`failComment`](#failcomment)\n    - [`failComment` Example](#failcomment-example)\n    - [`releasedLabels`](#releasedlabels)\n    - [`releasedLabels` Example](#releasedlabels-example)\n    - [`addReleases`](#addreleases)\n    - [`addReleases` example](#addreleases-example)\n- [Contributing](#contributing)\n  - [Affiliates](#affiliates)\n- [License](#license)\n\n\u003ca href=\"#overview\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\n\n## Overview\n\nThis [semantic-release](https://github.com/semantic-release/semantic-release) plugin is a fork of the official [@semantic-release/github](https://www.npmjs.com/package/@semantic-release/github) plugin. It allows you to specify the `repositoryUrl` (normally inferred from `package.json`) as a configuration parameter. This opens the door to being able to publish with multiple plugins that rely on different values for `repositoryUrl`. [semantic-release-config](https://github.com/ProfessorManhattan/semantic-release-config) uses this plugin to publish to GitLab Releases and GitHub Releases from within the same flow.\n\n\u003ca href=\"#requirements\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\n\n## Requirements\n\nIf you are simply including this library in your project, all you need is a recent version of Node.js. **[Node.js \u003e14.18.0](repository.project.node)** is sometimes required and is the only version range we actively support. Albeit, it is highly probable that lower versions will work as well depending on the requirements that this project imports.\n\n### Developer Requirements\n\nThe following versions of Node.js and Python are required for development:\n\n- **[Node.js \u003e14.18.0](repository.project.node)**\n- **[Python \u003e3.10.0](repository.project.python)**\n\nOther versions may work, but only the above versions are supported. Most development dependencies are installed automatically by our `Taskfile.yml` set-up (even Node.js and Python). Run `bash start.sh` to install **[Bodega](https://github.com/ProfessorManhattan/Bodega)** (an improved fork of [go-task](https://github.com/go-task/task)) and run the initialization sequence. The taskfiles will automatically install dependencies as they are needed, based on what development tasks you are running. For more information, check out the [CONTRIBUTING.md](https://github.com/megabyte-labs/semantic-release-gh/blob/main/docs/CONTRIBUTING.md) or simply run:\n\n```shell\nnpm run help\n```\n\n`npm run help` will ensure Bodega is installed and then open an interactive dialog where you can explore and learn about various developer commands.\n\n\u003ca href=\"#summary\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\n\n## Summary\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| 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\u003ca href=\"#install\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\n\n## Install\n\n```bash\n$ npm install --save-dev semantic-release-gh\n```\n\n\u003ca href=\"#usage\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\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    [\n      \"semantic-release-github\",\n      {\n        \"repositoryUrl\": \"https://github.com/professormanhattan/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```\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\u003ca href=\"#configuration\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\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](\u003cgithub_release_url\u003e)` |\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\u003c%= nextRelease.channel ? \\` on @\\${nextRelease.channel}\\` : \"\" %\u003e']-                                                                     |\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 distribution'}]`: include the `dist/MyLibrary.js` and `dist/MyLibrary.css` files, and label them `MyLibrary JS distribution` 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\u003e `[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\u003e 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.\u003cbr\u003e`pluginName` contains the package name of the plugin that threw the error.\u003cbr\u003e`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 =\u003e err.message).join('\\\\n- ')}` will generate the comment:\n\n\u003e This release from branch master had failed due to the following errors:\n\u003e\n\u003e - Error message 1\n\u003e - 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\u003c%= nextRelease.channel ? ` on @\\${nextRelease.channel}` : \"\" %\u003e from \u003c%= branch.name %\u003e'] `` will generate the label:\n\n\u003e 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.\n\n\u003ca href=\"#contributing\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/megabyte-labs/semantic-release-gh/issues). If you would like to contribute, please take a look at the [contributing guide](https://github.com/megabyte-labs/semantic-release-gh/blob/master/docs/CONTRIBUTING.md).\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cb\u003eSponsorship\u003c/b\u003e\u003c/summary\u003e\n\u003cbr/\u003e\n\u003cblockquote\u003e\n\u003cbr/\u003e\nDear Awesome Person,\u003cbr/\u003e\u003cbr/\u003e\nI create open source projects out of love. Although I have a job, shelter, and as much fast food as I can handle, it would still be pretty cool to be appreciated by the community for something I have spent a lot of time and money on. Please consider sponsoring me! Who knows? Maybe I will be able to quit my job and publish open source full time.\n\u003cbr/\u003e\u003cbr/\u003eSincerely,\u003cbr/\u003e\u003cbr/\u003e\n\n**_Brian Zalewski_**\u003cbr/\u003e\u003cbr/\u003e\n\n\u003c/blockquote\u003e\n\n\u003ca title=\"Support us on Open Collective\" href=\"https://opencollective.com/megabytelabs\" target=\"_blank\"\u003e\n  \u003cimg alt=\"Open Collective sponsors\" src=\"https://img.shields.io/opencollective/sponsors/megabytelabs?logo=opencollective\u0026label=OpenCollective\u0026logoColor=white\u0026style=for-the-badge\" /\u003e\n\u003c/a\u003e\n\u003ca title=\"Support us on GitHub\" href=\"https://github.com/ProfessorManhattan\" target=\"_blank\"\u003e\n  \u003cimg alt=\"GitHub sponsors\" src=\"https://img.shields.io/github/sponsors/ProfessorManhattan?label=GitHub%20sponsors\u0026logo=github\u0026style=for-the-badge\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://www.patreon.com/ProfessorManhattan\" title=\"Support us on Patreon\" target=\"_blank\"\u003e\n  \u003cimg alt=\"Patreon\" src=\"https://img.shields.io/badge/Patreon-Support-052d49?logo=patreon\u0026logoColor=white\u0026style=for-the-badge\" /\u003e\n\u003c/a\u003e\n\n### Affiliates\n\nBelow you will find a list of services we leverage that offer special incentives for signing up for their services through our special links:\n\n\u003ca href=\"http://eepurl.com/h3aEdX\" title=\"Sign up for $30 in MailChimp credits\" target=\"_blank\"\u003e\n  \u003cimg alt=\"MailChimp\" src=\"https://cdn-images.mailchimp.com/monkey_rewards/grow-business-banner-2.png\" /\u003e\n\u003c/a\u003e\n\u003ca href=\"https://www.digitalocean.com/?refcode=751743d45e36\u0026utm_campaign=Referral_Invite\u0026utm_medium=Referral_Program\u0026utm_source=badge\"\u003e\n  \u003cimg src=\"https://web-platforms.sfo2.digitaloceanspaces.com/WWW/Badge%203.svg\" alt=\"DigitalOcean Referral Badge\" /\u003e\n\u003c/a\u003e\n\n\u003c/details\u003e\n\n\u003ca href=\"#license\" style=\"width:100%\"\u003e\u003cimg style=\"width:100%\" src=\"https://gitlab.com/megabyte-labs/assets/-/raw/master/png/aqua-divider.png\" /\u003e\u003c/a\u003e\n\n## License\n\nCopyright © 2020-2021 [Megabyte LLC](https://megabyte.space). This project is [MIT](https://gitlab.com/megabyte-labs/npm/plugin/semantic-release-gh/-/blob/master/LICENSE) licensed.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofessormanhattan%2Fsemantic-release-gh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprofessormanhattan%2Fsemantic-release-gh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprofessormanhattan%2Fsemantic-release-gh/lists"}