https://github.com/neverendingqs/publish-me-maybe

Only publishes a NPM package if the version is later than what is available.
https://github.com/neverendingqs/publish-me-maybe

npm npm-publish

Last synced: 6 days ago
JSON representation

Only publishes a NPM package if the version is later than what is available.

• Host: GitHub
• URL: https://github.com/neverendingqs/publish-me-maybe
• Owner: neverendingqs
• License: mit
• Created: 2019-10-15T18:51:19.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-06-24T05:09:34.000Z (over 1 year ago)
• Last Synced: 2024-10-14T13:36:22.998Z (about 1 month ago)
• Topics: npm, npm-publish
• Language: JavaScript
• Size: 402 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: MIT-LICENSE

Awesome Lists containing this project

README

        
# publish-me-maybe

[![CircleCI](https://circleci.com/gh/neverendingqs/publish-me-maybe.svg?style=svg)](https://circleci.com/gh/neverendingqs/publish-me-maybe)

[![npm version](https://badge.fury.io/js/publish-me-maybe.svg)](https://badge.fury.io/js/publish-me-maybe)

_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'](http://npmjs.org/doc/publish.html) 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](https://github.com/neverendingqs/publish-me-maybe/blob/master/MIT-LICENSE)