Package Exports

@khala/wildcard-release-notes

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 (@khala/wildcard-release-notes) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Monorepo wild card release notes

Monorepo release notes based on @khala/commit-analyzer-wildcard for semantic-release package.

Installation

Using NPM

> npm install -D @khala/wildcard-release-notes

Using yarn

> yarn add -D @khala/wildcard-release-notes

Then add it to your generateNotesoptions

package.json

{
  "release": {
    "generateNotes": [
      {
        "path": "@khala/wildcard-release-notes"
      }
    ]
  }
}

Options

This package will assume that you want to generate release notes for packages under root folder you ran release. If you want to release packages under different folder (for instance all packages under folder plugins) you have to add folder option to generateNotes option. Or if you want to set this up globally add monorepo prop to release config.

{
  "release": {
    "generateNotes": [
      {
        "path": "@khala/wildcard-release-notes",
        "folder": "./plugins"
      }
    ]
  }
}

{
  "release": {
    "monorepo": "./plugins",
    "generateNotes": "@khala/wildcard-release-notes"
  }
}

If you are not using Travis as your CI environment, you can specify the repository name (GitHub) manually:

{
  "release": {
    "generateNotes": [
      {
        "path": "@khala/wildcard-release-notes",
        "folder": "./plugins",
        "repositoryName": "organisation/repository"
      }
    ]
  }
}

Otherwise env.TRAVIS_REPO_SLUG is used automatically.