README.md in bump-0.9.0 vs README.md in bump-0.10.0
- old
+ new
@@ -15,11 +15,11 @@
### Show current version
bump current
-> Current version: 0.1.2
+> 0.1.2
### Bump (major, minor, patch, pre)
bump patch
@@ -27,17 +27,17 @@
### Show next version
bump show-next patch
-> Next patch version: 0.1.3
+> 0.1.3
### Show version file path
bump file
-> Version file path: lib/foo/version.rb
+> lib/foo/version.rb
## Options
### `--no-commit`
@@ -64,11 +64,11 @@
### `--replace-in`
Bump the version in additional files.
- bump patch --reaplace-in Readme.md
+ bump patch --replace-in Readme.md
### `--commit-message [MSG], -m [MSG]`
Append additional information to the commit message.
@@ -78,21 +78,31 @@
bump patch -m "Something extra"
### `--changelog`
-Update `CHANGELOG.md` when bumping.
+Updates `CHANGELOG.md` when bumping.
This requires a heading (starting with `##`) that includes the previous version and a heading above that, for example:
```markdown
### Next
- Added bar
### v0.0.0 - 2019-12-24
- Added foo
```
+### `--edit-changelog`
+
+Updates CHANGELOG.md when bumping (see above), and
+opens the changelog in an editor specified in `$EDITOR` (or `vi`),
+then waits for the editor to be closed and continues.
+
+```bash
+EDITOR="subl -n -w" bump patch --edit-changelog
+```
+
## Rake
```ruby
# Rakefile
require "bump/tasks"
@@ -104,9 +114,11 @@
# bump the version in additional files
# Bump.replace_in_default = ["Readme.md"]
#
# Maintain changelog:
# Bump.changelog = true
+# Opens the changelog in an editor when bumping
+# Bump.changelog = :editor
```
rake bump:current # display current version
rake bump:show-next INCREMENT=minor # display next minor version
rake bump:file # display version file path