- Notifications
You must be signed in to change notification settings - Fork0
A set of utilities for working with Conventional Commits in Ruby environments
License
dabarrell/conventional
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Note: Under active development - expect breaking changes.
conventional bridges the gap in automating version management for Ruby gems from start to finish. UsingConventional Commits, it allows you to automate the process from commit to release.
Add this line to your Gemfile:
gem'conventional'
and runbundle install from your shell.
To install the gem manually, run:
gem install conventionalBumps gem according to conventional commits
Usage: conventional bumpOptions: --level=VALUE # The level of bump to execute (determined automatically if not provided): (patch/minor/major) --[no-]tag # Create and push git tag, default: true --message=VALUE # Commit message template, default: "chore: Release v%{version} [skip ci]" --[no-]push # Push changes to git remote, default: true --[no-]dry-run # Completes a dry run without making any changes, default: false --help, -h # Print this helpReturns the recommended bump level according to conventional commits
Usage: conventional recommended-bumpOptions: --help, -h # Print this helpCheck out these similar projects, which served as inspiration forconventional.
conventional-changelog(JS)lerna(JS)github-changelog-generator(Ruby)gem-release(Ruby)
conventional is distributed under theMIT License.
- David Barrell (@dabarrell,davidbarrell.me)
About
A set of utilities for working with Conventional Commits in Ruby environments