standard-version-updater-yaml

standard-version-updater-yaml

A YAML updater for standard-version.

Installation

# latest stable
npm install standard-version-updater-yaml

Usage

In your .versionrc.js file:

const standardVersionUpdaterYaml = require.resolve("standard-version-updater-yaml");

module.exports = {
  ...,
  bumpFiles: [
    {
      filename: "file.yml",
      updater: standardVersionUpdaterYaml
    }
  ]
};

- or -

module.exports = {
  ...,
  bumpFiles: [
    {
      filename: "file.yml",
      updater: require.resolve("standard-version-updater-yaml")
    }
  ]
};

YAML structure

This updater will only update a root version tag inside of a YAML file.

Correct structure ✔

name: My package
version: 1.0.0

Incorrect structure ❌

package:
  name: My package
  version: 1.0.0

Versioning

This project uses Semantic Versioning 2.0.0 to keep track of releases.

For more detailed information about SemVer, please see the official documentation.

Contributing

If you're interested in contributing to the project, please read the Contribution Guidelines. Any and all contributions must follow these guidelines or they will not be accepted.