NAME
Dist::Zilla::Plugin::Git::CheckFor::Fixups - Check your repo for fixup! and squash! before release
VERSION
This document describes version 0.014 of Dist::Zilla::Plugin::Git::CheckFor::Fixups - released October 10, 2016 as part of Dist-Zilla-PluginBundle-Git-CheckFor.
SYNOPSIS
; in dist.ini -- note we depend on Git::NextVersion for versioning info
[Git::NextVersion]
[Git::CheckFor::Fixups]
DESCRIPTION
This is a simple Dist::Zilla plugin to check that since the last release, you have no fixup or squash commits remaining in your history. The presence of these commits is almost certainly an oversight, so if any are found the release is aborted.
Note that we do not check for the presence of such commits in the history of older releases; having a fixup commit in the history is embarrassing, but not so much so as rebasing to resolve a blemish in the deep, dark, sordid past of the project.
WHAT'S A FIXUP OR SQUASH COMMIT?
A squash or fixup commit is one with a commit message formatted in such a manner that git rebase --autosquash
will recognize it; namely:
A fixup commit has a commit message beginning with 'fixup! '
A squash commit has a commit message beginning with 'squash! '
SEE ALSO
Please see those modules/websites for more information related to this module.
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, Gratipay, or indulge my Amazon Wishlist... If and *only* 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