JSPM

  • Created
  • Published
  • Downloads 66641
  • Score
    100M100P100Q157112F
  • License MIT

Plugins for `semantic-release` allowing it to be used with a monorepo.

Package Exports

  • semantic-release-monorepo

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (semantic-release-monorepo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

semantic-release-monorepo

Build Status npm semantic-release

Apply semantic-release's automatic publishing to a monorepo.

Why

The default configuration of semantic-release assumes a one-to-one relationship between a Github repository and an npm package.

This plugin allows using semantic-release with a single Github repository containing many npm packages.

How

Rather than attributing all commits to a single package, this plugin will automatically assign commits to packages based on the files that a commit touched.

If a commit touched a file within a package's root, it will be considered for that package's next release. Yes, this means a single commit could belong to multiple packages

A push may release multiple package versions. In order to avoid version collisions, git tags are namespaced using the given package's name.

Configuration

This package is a complement to semantic-release. It is assumed the user is already fully familiar with that package and its workflow.

Install

npm install -D semantic-release-monorepo

Usage

In package.json:

{
  "release": {
    "analyzeCommits": "semantic-release-monorepo",
    "generateNotes": "semantic-release-monorepo",
    "publish": "semantic-release-monorepo"
  }
}