@getyourguide/npm-publish

NpmPublish

Module to handle publishing new modules detecting the version type from the commit message and pushing to github.

Features

• Allow to define increment (patch, minor, major) based on commit message.
• Allow to create beta versions from commits.
• Increate automatically version in package.json and push to your github repo.

Getting Started

npm install --save @getyourguide/npm-publish

Usage with drone

1. Create a npm script in your package.json

{
  "scripts": {
    "publish": "npm-publish"
  }
}

1. Add a step in drone to publish your module

publish-package:
  image: node:12-buster
  commands:
    - npm run publish -- -b "${DRONE_BRANCH}" -m '${DRONE_COMMIT_MESSAGE/"/}'

Params

Run with --help to get a full list of params

npm run publish -- --help

Options:
  --version              Show version number                           [boolean]
  --help                 Show help                                     [boolean]
  --branch, -b           branch name                                   [required]
  --message, -m          commit message                                [required]
  --publish-branches     branches in which it should publish [default: "master"]
  --wildcard-minor       wildcard to identify a minor commit [default: "[minor]"]
  --wildcard-major       wildcard to identify a major commit [default: "[major]"]
  --wildcard-beta        wildcard to identify a beta commit  [default: "[beta]"]
  --wildcard-no-publish  wildcard to identify a skip publish [default: "[nopublish]"]

Add config in package.json

Create a section in your package.json and overide the default values

{
  "npm-publish": {
    "publish-branches": ["master"],
    "wildcard-minor": "[minor]",
    "wildcard-major": "[major]",
    "wildcard-beta": "[beta]",
    "wildcard-no-publish": "[nopublish]",
  }
}