> **The official GitHub plugin, modified to accept repositoryUrl as a parameter**
## Table of Contents
- [Overview](#overview)
- [Requirements](#requirements)
- [Developer Requirements](#developer-requirements)
- [This Repository (Shared Common)](#this-repository-shared-common)
- [Contributing](#contributing)
- [License](#license)
## Overview
This [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.
## Requirements
If you are simply including this library in your project, all you need is a recent version of Node.js. **[Node.js >14.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.
### Developer Requirements
The following versions of Node.js and Python are required for development:
- **[Node.js >14.18.0](repository.project.node)**
- **[Python >3.10.0](repository.project.python)**
Other 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:
```shell
npm run help
```
`npm run help` will ensure Bodega is installed and then open an interactive dialog where you can explore and learn about various developer commands.
## This Repository (Shared Common)
This repository houses files that propagate downstream to project-specific repositories.
## Contributing
Contributions, 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).
Sponsorship
Dear Awesome Person,
I 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.
Sincerely,
**_Brian Zalewski_**
## License
Copyright © 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.
