NAME

App::GitHooks::Plugin::RequireCommitMessage - Require a commit message.

DESCRIPTION

If you are using App::GitHooks::Plugin::RequireTicketID, commit messages will need to include a ticket ID but the rest of the commit message can be empty. To prevent this, this plugin looks at the commit message, excluding the ticket ID, and requires that it is not empty before allowing the commit to go through.

VERSION

Version 1.2.0

METHODS

run_commit_msg()

Code to execute as part of the commit-msg hook.

my $success = App::GitHooks::Plugin::RequireCommitMessage->run_commit_msg();

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks-Plugin-RequireCommitMessage/issues/new. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc App::GitHooks::Plugin::RequireCommitMessage

You can also look for information at:

• GitHub's request tracker

  https://github.com/guillaumeaubert/App-GitHooks-Plugin-RequireCommitMessage/issues

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/app-githooks-plugin-requirecommitmessage

• CPAN Ratings

  http://cpanratings.perl.org/d/app-githooks-plugin-requirecommitmessage

• MetaCPAN

  https://metacpan.org/release/App-GitHooks-Plugin-RequireCommitMessage

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2013-2017 Guillaume Aubert.

This code is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.