https://github.com/78nine/release-commit
Commit (and tag) a release with automatic CHANGELOG.md and DEPENDENCIES.md updates
https://github.com/78nine/release-commit
changelog commit commits dependencies deploy generate git log release workflow
Last synced: 6 months ago
JSON representation
Commit (and tag) a release with automatic CHANGELOG.md and DEPENDENCIES.md updates
- Host: GitHub
- URL: https://github.com/78nine/release-commit
- Owner: 78nine
- License: other
- Created: 2017-06-16T16:20:39.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-07-30T14:13:13.000Z (almost 4 years ago)
- Last Synced: 2024-04-25T22:43:32.844Z (about 2 years ago)
- Topics: changelog, commit, commits, dependencies, deploy, generate, git, log, release, workflow
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/release-commit
- Size: 503 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# release-commit
This is a fork and re-work of [commit-release](https://www.npmjs.com/package/commit-release) (by [Jamie Mason](https://www.npmjs.com/~fold_left))
When run it updates CHANGELOG.md and DEPENDENCIES.md files,
bumps version number in `package.json` and (optionally) tags the commit.
## Install
```shell
npm i -g release-commit
```
or
```shell
npm i -D release-commit
```
depending on your preferences
## Usage
```shell
$ release-commit --help
Usage: release-commit [options]
Options:
-V, --version output the version number
-f, --force overwrite tag if it exists already
-n, --no-verify skip git commit hooks
-o, --override [version] override recommended version number (default: "")
-p, --postfix [name] a postfix such as "rc1", "canary" or "beta1" (default: "")
-t, --tag also tag the commit
-d, --debug useful if you face any error; outputs full error stack trace
-h, --help display help for command
```