Code::TidyAll::Git::Prereceive - Git pre-receive hook that requires files to be tidyall'd
In .git/hooks/pre-receive: #!/usr/bin/perl use Code::TidyAll::Git::Prereceive; use strict; use warnings; Code::TidyAll::Git::Prereceive->check();
This is typically used to validate pushes from multiple developers to a shared repo, possibly on a remote server.
See also Code::TidyAll::Git::Precommit, which operates locally.
Class method. Check that all files being added or modified in this push are tidied and valid according to tidyall. If not, then the entire push is rejected and the reason(s) are output to the client. e.g.
% git push Counting objects: 9, done. ... remote: [checked] lib/CHI/Util.pm remote: Code before strictures are enabled on line 13 [TestingAndDebugging::RequireUseStrict] remote: remote: 1 file did not pass tidyall check To ... ! [remote rejected] master -> master (pre-receive hook declined)
The configuration file (
.tidyallrc) must be checked into git in the repo root directory, i.e. next to the .git directory.
In an emergency the hook can be bypassed by pushing the exact same set of commits 3 consecutive times (configurable via "allow_repeated_push"):
% git push ... remote: 1 file did not pass tidyall check % git push ... *** Identical push seen 2 times remote: 1 file did not pass tidyall check % git push ... *** Identical push seen 3 times *** Allowing push to proceed despite errors
Or you can disable the hook in the repo being pushed to, e.g. by renaming .git/hooks/pre-receive.
Passes mode = "commit" by default; see modes.
Number of times a push must be repeated exactly after which it will be let through regardless of errors. Defaults to 3. Set to 0 or undef to disable this feature.
Conf file name to search for instead of the defaults.
A listref of extra configuration files referred to from the main configuration file, e.g.
extra_conf_files => ['perlcriticrc', 'perltidyrc']
These files will be pulled out of the repo alongside the main configuration file. If you don't list them here then you'll get errors like 'cannot find perlcriticrc' when the hook runs.
Path to git to use in commands, e.g. '/usr/bin/git' or '/usr/local/bin/git'. By default, just uses 'git', which will search the user's PATH.
Subclass to use instead of Code::TidyAll
Hashref of options to pass to the Code::TidyAll constructor. You can use this to override the default options
mode => 'commit', quiet => 1,
or pass additional options.
Jonathan Swartz <firstname.lastname@example.org>
This software is copyright (c) 2011 by Jonathan Swartz.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.