rpidanny / semantic-release-update-package.json Goto Github PK

View Code? Open in Web Editor NEW

A semantic-release plugin that updates package.json with the new release version.

Shell 2.28% JavaScript 13.13% TypeScript 84.59%

semantic-release-update-package.json's Introduction

semantic-release-update-package.json

semantic-release plugin that updates package.json with the new release version.

This tool is especially useful when using semantic-release-plus with mono-repo frameworks like nx.

Install

$ npm i --save-dev @rpidanny/semantic-release-update-package.json

Usage

The plugin can be configured in the semantic-release configuration file:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "@rpidanny/semantic-release-update-package.json",
      {
        "packageJsonPath": "./packages/core/package.json"
      }
    ]
  ]
}

With this example, for each release, the package.json at ./packages/core/package.json will be updated with the latest release version.

Configuration

Options

Options	Description	Type	Required
`packageJsonPath`	Path where the `package.json` is stored at.	`string`	`true`

Examples

When used with the @semantic-release/git plugins the @rpidanny/semantic-release-update-package.json plugin must be called first in order to update the package.json file so the @semantic-release/git plugin can include it in the release commit.

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    [
      "@rpidanny/semantic-release-update-package.json",
      {
        "packageJsonPath": "./packages/core/package.json"
      }
    ],
    [
      "@semantic-release/npm",
      {
        "npmPublish": false
      }
    ],
    "@semantic-release/github",
    [
      "@semantic-release/git",
      {
        "assets": [
          "CHANGELOG",
          "package.json",
          "package-lock.json",
          "./packages/core/package.json"
        ],
        "message": "chore(release): ${nextRelease.version} [skip-ci]\n\n${nextRelease.notes}"
      }
    ]
  ]
}

Recommend Projects