Dist::Zilla::Plugin::Git::CheckFor::CorrectBranch(3)

NAME
Dist::Zilla::Plugin::Git::CheckFor::CorrectBranch - Check that you're on the correct branch before release

VERSION
This document describes version 0.015 of Dist::Zilla::Plugin::Git::CheckFor::CorrectBranch - released August 08, 2026 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.

•   Dist::Zilla::PluginBundle::Git::CheckFor

•   Dist::Zilla

•   Dist::Zilla::Plugin::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>

COPYRIGHT AND LICENSE
This software is Copyright (c) 2026 by Chris Weyl.

This is free software, licensed under:

  The GNU Lesser General Public License, Version 2.1, February 1999