Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

publish-me-maybe

1.0.7 • Public • Published

publish-me-maybe

CircleCI npm version

Fork of https://github.com/cmanzana/node-publish. Forked due to user inactivity on GitHub.

npm module to automate publishing of npm modules. Useful when you want to publish every time you bump the version in your module as part of your continuos integration setup.

When running publish-me-maybe in your module:

  • if your module is not yet in the registry then it will do nothing (you need to publish manually the first version of your module)
  • if your module has the same version, or lower version than the version in the registry then it will do nothing
  • if your module has bigger version than the version in the registry then it will perform a 'npm publish' of your module

Installation

npm install publish-me-maybe

Usage

The most common way of using publish-me-maybe is to have it as a posttest script in your package.json:

"scripts": {
  "test": "tap test/*.js", // tap as an example
  "posttest": "publish"
}

which means that on successful test run, it will try to 'npm publish' your module.

Notice that your CI machine needs to be configured with an npm user (http://npmjs.org/doc/adduser.html) that is authorized to publish the package.

The options that you can use are:

  • --on-major Publishes on major version changes.
  • --on-minor Publishes on minor version changes.
  • --on-patch Publishes on patch version changes.
  • --on-build Publishes on build version changes.
  • --test Prints the versions of the packages and whether it would publish.
  • --tag Publishes the change with the given tag. (npm defaults to 'latest')
  • --version Print the version of publish-me-maybe.
  • --help Print the help of publish-me-maybe.

Examples

publish --on-major --on-minor

will only publish when the local major or minor versions are higher than the remote ones

publish --on-build

will only publish when the local build version is higher than the remote one

publish

will only publish when the local version is higher than the remote one

License

MIT

Install

npm i publish-me-maybe

DownloadsWeekly Downloads

18

Version

1.0.7

License

MIT

Unpacked Size

18.3 kB

Total Files

13

Last publish

Collaborators

  • avatar