https://github.com/design4pro/release-me
Replacement for `npm version` with automatic CHANGELOG generation
https://github.com/design4pro/release-me
changelog conventional-changelog release
Last synced: 24 days ago
JSON representation
Replacement for `npm version` with automatic CHANGELOG generation
- Host: GitHub
- URL: https://github.com/design4pro/release-me
- Owner: design4pro
- License: mit
- Created: 2017-06-01T07:51:47.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-09-12T07:11:07.000Z (over 7 years ago)
- Last Synced: 2025-02-14T08:25:27.764Z (over 1 year ago)
- Topics: changelog, conventional-changelog, release
- Language: JavaScript
- Homepage:
- Size: 257 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Release Me
[](https://travis-ci.org/design4pro/release-me) [](https://circleci.com/gh/design4pro/release-me) [](https://codecov.io/gh/design4pro/release-me) [](https://www.npmjs.com/package/release-me) [](https://www.npmjs.com/package/release-me) [](https://greenkeeper.io/)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fdesign4pro%2Frelease-me?ref=badge_shield)
> stop using npm version, use release-me
Automatic versioning and CHANGELOG generation.
How it works:
1. when you're ready to release to npm:
2. `git checkout master; git pull origin master`
3. `run release-me`
4. `git push --follow-tags origin master; npm publish`
`release-me` does the following:
1. bumps the version in package.json/bower.json (based on your commit history)
2. uses conventional-changelog (with [conventional-changelog-release-me](https://github.com/design4pro/conventional-changelog-release-me) preset) to update CHANGELOG.md
3. commits package.json (et al.) and CHANGELOG.md
4. tags a new release
###Installation
**As npm run script**
Install and add to devDependencies:
```bash
npm i --save-dev release-me
```
Add an npm run script to your package.json:
```json
{
"scripts": {
"release": "release-me"
}
}
```
Now you can use npm run release in place of npm version.
This has the benefit of making your repo/package more portable, so that other developers can cut releases without having to globally install `release-me` their machine.
**As global bin**
Install globally (add to your PATH):
```bash
npm i -g release-me
```
Now you can use `release-me` in place of npm version.
This has the benefit of allowing you to use `release-me` on any repo/package without adding a dev dependency to each one.
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fdesign4pro%2Frelease-me?ref=badge_large)