hoe-git2

= Hoe Loves Git

• home :: http://github.com/halostatue/hoe-git
• docs :: http://docs.seattlerb.org/hoe-git

== Description

A set of Hoe plugins for tighter Git integration. Provides tasks to automate release tagging and pushing and changelog generation. I expect it'll learn a few more tricks in the future.

This is an evolution of +hoe-git+ by John Barnette, which has been archived at http://github.com/jbarnette/hoe-git.

== Examples

# in your Rakefile
Hoe.plugin :git2

If this plugin cannot see that it is in a .git directory, it'll silently deactivate itself.

=== Autogenerating the Changelog

$ rake git:changelog

This takes all the commit messages since your last release and formats 'em into a nice RDoc fragment. If you specify VERSION, it'll be used in the changelog fragment. If you specify FROM, it'll be used as a starting point for the changelog instead of your last tagged release.

The rdoc is automatically formatted into sections by using "annotated commit messages" by using a simple format for multi-line commit messages:

! major change description.
+ minor change description.
- bug fix description.
un-logged description (for minor stuff like re-formatting).

=== Generating the Manifest

$ rake git:manifest

This will regenerate Manifest.txt using git ls-files. It respects Hoe's manifest sort order and excludes.

=== Tagging and Sanity Checking a Release

$ rake release VERSION=1.0.0

In addition to the normal RubyForge release process, this will create and push a v1.0.0 tag. It'll also abort the release if your index is dirty, or if there are untracked files present.

=== git-svn

The git:changelog and git:tag tasks understand git-svn repositories, and will adjust their behavior accordingly.

== Dependencies

Hoe and Git, obviously. I wouldn't be surprised if things don't quite work for git < 2.37.

== Installation

$ gem install hoe-git2

== TODO

• Release tags are sorted lexicographically right now, which won't work for long.

== License

Copyright 2009 John Barnette ([e-mail]) Copyright 2022 Austin Ziegler ([e-mail])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.