README.md

Version-Pong

Publish npm package and automated bump version in the package.json based on Standard Version.

Version Pong Abilities

4 Steps will be performed in 1 Command!

1. Update Peer Dependencies versions
2. Tagging Version and Generate Auto Changelog
3. Publish to npm registry
4. Push all release change to target branch

Installation

As Global CLI

$ yarn global add version-pong

Local Project

$ yarn add -D version-pong

In package.json

{
    "scripts": {
        "release": "version-pong"
    },
    "version-pong": {
      "method": "yarn build && yarn publish"
    }
}

Settings

• method - The method that perform for publishing library

What is watchDependencies?

If your package need to define peerDependencies, add target peer dependency package name to watchDependencies

add library name to watchDependencies.

example

In package.json

{
    "devDependencies": {
      "jest": "^26.0.1",
    },
    "watchDependencies": ["jest"]
}

Once version-pong is run with published command, it automatically generates peerDependencies.

example

In package.json

{
    "devDependencies": {
      "jest": "^26.0.1",
    },
    "watchDependencies": ["jest"],
    "peerDependencies": {
      "jest": ">=26.0.1",
    }
}

Settings

• watchDependencies - List of devDependencies to be convert to peerDependencies.
• peerDependencies - Auto Generated Dependencies in >=xx.xx.xx version format with watchDependencies by version-pong.

Usage

Publish Library

$ version-pong <tag>

example

$ version-pong minor

Publish with git tagPrefix

$ version-pong <tag> -t <tagPrefix>

example

$ version-pong minor -t eslint

Tag

Production Release (Master Branch Only)

• Major - Breaking Change Release
• Minor - Non-Breaking Change Release
• Patch - Bug fix Release

Development Release (Dev Branch Only)

• Beta - Development Release

Option

• -t , --tagPrefix : git tag prefix
  • ex. [email protected] (tagPrefix is eslint)

Contributors ✨

• Norapat Buppodom - new5558
• Phasin Sarunpornkul - gunhappy
• Thanadej Phadtong - Thanadej8
• Voraton Lertrattanapaisal - ReiiYuki
• LINE MAN Wongnai Frontend Team