@garagesale/common
v1.4.2
Published
This document outlines the steps to publish a new version of the package to NPM.
Readme
Publishing to NPM
This document outlines the steps to publish a new version of the package to NPM.
Prerequisites
- Make sure you have npm access and are logged in (
npm login) - Ensure all changes are tested and working
- Make sure your working directory is clean
Publishing Steps
Stage all changes:
git add .Commit your changes:
git commit -m "your commit message"Update the version number. Choose one of:
npm version patch # for bug fixes (0.0.x) npm version minor # for new features (0.x.0) npm version major # for breaking changes (x.0.0)Build the package:
npm run buildPublish to NPM:
npm publish
Version Guidelines
patch(0.0.x) - Bug fixes and minor changesminor(0.x.0) - New features (non-breaking)major(x.0.0) - Breaking changes
Notes
- The
npm versioncommand will automatically create a git tag - Make sure your git working directory is clean before publishing
- Consider adding a changelog entry for significant changes
