/release-config

A shared configuration for semantic-release

Primary LanguageJavaScriptMIT LicenseMIT

@th3s4mur41/release-config

Open in GitHub Codespaces

Package version GitHub last commit Release

A configuration for semantic-release that will create patches for dependencies updates

Prerequistes

Install NPM

Install Node.js and NPM in your local development environment by following the instructions at npmjs.com. When installation is complete, verify you can use NPM in your terminal by running:

npm --version

The NPM version is shown in the output:

8.1.0

Create a project

Skip this step if you already have a package.json

To create a project:

Create an empty directory. Go to the directory and initialize an empty package by running:

npm init

Enter responses to the questions. Ensure the package name follows the naming convention and is scoped to the project or group where the registry exists.

A package.json file is created

Installation

npm install @th3S4mur41/release-config

or

yarn add @th3S4mur41/release-config

Usage

Add a .releaserc.json file to the root of your project with the following content:

{
"extends": "@th3S4mur41/release-config"
}

Done, now you can release your project automatically by running npx semantic-release