View on
MetaCPAN
Dave Rolsky > Code-TidyAll > Code::TidyAll::Git::Prereceive

Download:
Code-TidyAll-0.69.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.69   Source  

NAME ^

Code::TidyAll::Git::Prereceive - Git pre-receive hook that requires files to be tidyall'd

VERSION ^

version 0.69

SYNOPSIS ^

  In .git/hooks/pre-receive:

    #!/usr/bin/perl
    use Code::TidyAll::Git::Prereceive;
    use strict;
    use warnings;

    Code::TidyAll::Git::Prereceive->check();


    # or

    my $input = do { local $/; <STDIN> };

    # Do other things with $input here

    my $hook = Code::TidyAll::Git::Prereceive->new();
    if (my $error = $hook->check_input($input)) {
        die $error;
    }

DESCRIPTION ^

This module implements a Git pre-receive hook that checks if all pushed files are tidied and valid according to tidyall, and rejects the push if not.

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.

METHODS ^

This class provides the following methods:

Code::TidyAll::Git::Prerecive->check(%params)

This method reads commit info from standard input, then checks 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 (tidyall.ini or .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.

If an unexpected runtime error occurs, it is reported but by default the commit will be allowed through (see "reject_on_error").

Passes mode = "commit" by default; see modes.

Key/value parameters:

Code::TidyAll::Git::Prereceive->new(%params)

This takes the same parameters documented as documented in check above and returns a new object which you can then call check_input on.

$prereceive->check_input($input)

Runs a check on $input, the text block of lines that came from standard input. You can call this manually before or after you do other processing on the input. Returns an error string if there was a problem or undef if there were no problems.

KNOWN BUGS ^

This hook will ignore any files with only a single line of content (no newlines), as an imperfect way of filtering out symlinks.

SUPPORT ^

Bugs may be submitted at https://github.com/houseabsolute/perl-code-tidyall/issues.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.

SOURCE ^

The source code repository for Code-TidyAll can be found at https://github.com/houseabsolute/perl-code-tidyall.

AUTHORS ^

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 - 2017 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.

The full text of the license can be found in the LICENSE file included with this distribution.

syntax highlighting: