Semantic-release-gh NPM

The official GitHub plugin, modified to accept repositoryUrl as a parameter

Overview

This semantic-release plugin is a fork of the official @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 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 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
Python >3.10.0

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 (an improved fork of go-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 or simply run:

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. If you would like to contribute, please take a look at the contributing guide.

Brian Zalewski