/ 
App-GitHooks-v1.9.0
River stage two • 19 direct dependents • 19 total dependents
/ App::GitHooks::Plugin::Test::CustomReply

NAME

App::GitHooks::Plugin::Test::CustomReply - A test plugin that allows specifying the return code.

DESCRIPTION

SYNOPSIS

use App::GitHooks::Constants qw( :PLUGIN_RETURN_CODES );
use App::GitHooks::Plugin::Test::CustomReply;

# In .githooksrc.
# [Test::CustomReply]
# pre-commit = PLUGIN_RETURN_FAILED
# prepare-commit-msg = PLUGIN_RETURN_PASSED

# Run hooks calling the plugin.

VERSION

Version 1.9.0

METHODS

get_file_pattern()

Return a pattern to filter the files this plugin should analyze.

my $file_pattern = App::GitHooks::Plugin::Test::CustomReply->get_file_pattern(
	app => $app,
);

get_file_check_description()

Return a description of the check performed on files by the plugin and that will be displayed to the user, if applicable, along with an indication of the success or failure of the plugin.

my $description = App::GitHooks::Plugin::Test::CustomReply->get_file_check_description();

SUPPORTED HOOKS

This plugin supports all the hooks defined in App::GitHooks::Hook::*, including file-level checks for the appropriate hooks:

run_applypatch_msg
run_commit_msg
run_post_applypatch
run_post_checkout
run_post_commit
run_post_merge
run_post_receive
run_post_rewrite
run_post_update
run_pre_applypatch
run_pre_auto_gc
run_pre_commit
run_pre_commit_file
run_pre_push
run_pre_rebase
run_pre_receive
run_prepare_commit_msg
run_update

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks/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::Test::CustomReply

You can also look for information at:

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.