NAME
Dist::Zilla::Plugin::Git::CheckFor::CorrectBranch - Check that you're on the correct branch before release
VERSION
This document describes version 0.012 of Dist::Zilla::Plugin::Git::CheckFor::CorrectBranch - released February 23, 2015 as part of Dist-Zilla-PluginBundle-Git-CheckFor.
SYNOPSIS
; in dist.ini
[Git::CheckFor::CorrectBranch]
; release_branch defaults to 'master'
release_branch = master
release_branch = stable
# on branch topic/geewhiz...
$ dzil release # ABENDs!
# ...and on branch master
$ dzil release # succeeds
# ...and on branch stable
$ dzil release # succeeds
DESCRIPTION
This is a simple Dist::Zilla plugin to check that you are on the correct branch before allowing a release... Its reason for existance is to prevent accidental releases being cut from topic branches: which are in general not unrecoverable, but annoying, messy, and (sometimes) embarrassing.
OPTIONS
release_branch
This is the name of the branch it is legal to release from: it defaults to 'master'. Multiple branches may be specified; you may want to allow 'master' and 'stable'.
SEE ALSO
Please see those modules/websites for more information related to this module.
SOURCE
The development version is on github at http://https://github.com/RsrchBoy/dist-zilla-pluginbundle-git-checkfor and may be cloned from git://https://github.com/RsrchBoy/dist-zilla-pluginbundle-git-checkfor.git
BUGS
Please report any bugs or feature requests on the bugtracker website https://github.com/RsrchBoy/dist-zilla-pluginbundle-git-checkfor/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
AUTHOR
Chris Weyl <cweyl@alumni.drew.edu>
I'm a material boy in a material world
Please note I do not expect to be gittip'ed or flattr'ed for this work, rather it is simply a very pleasant surprise. I largely create and release works like this because I need them or I find it enjoyable; however, don't let that stop you if you feel like it ;)
Flattr this, gittip me, or indulge my Amazon Wishlist... If you so desire.
COPYRIGHT AND LICENSE
This software is Copyright (c) 2012 by Chris Weyl.
This is free software, licensed under:
The GNU Lesser General Public License, Version 2.1, February 1999