NAME

SVN::Simple::Hook::PreCommit - Role for Subversion pre-commit hooks

VERSION

version 0.308

SYNOPSIS

package MyHook::Cmd;
use Any::Moose;
extends any_moose('X::App::Cmd');

package MyHook::Cmd::Command::pre_commit;
use Any::Moose;
extends any_moose('X::App::Cmd::Command');
with 'SVN::Simple::Hook::PreCommit';

sub execute {
    my ( $self, $opt, $args ) = @_;
    my $txn = $self->txn();

    warn $self->author, ' changed ',
        scalar keys %{ $self->root->paths_changed() }, " paths\n";

    return;
}

DESCRIPTION

This Moose / Mouse role gives you access to the current Subversion transaction for use in a pre-commit hook. It's designed for use with MooseX / MouseX::App::Cmd::Command classes, so consult the main MooseX / MouseX::App::Cmd documentation for details on how to extend it to create your scripts.

ATTRIBUTES

txn_name

Full name of the transaction to check in the repository.

transaction

The current Subversion transaction, automatically populated at object creation time when the txn_name is set.

author

The author of the current transaction as required by all SVN::Simple::Hook consumers.

root

The Subversion root node as required by all SVN::Simple::Hook consumers.

Example hooks/pre-commit hook script

#!/bin/sh

REPOS="$1"
TXN="$2"

perl -MMyHook::Cmd -e 'MyHook::Cmd->run()' pre_commit -r "$REPOS" -t "$TXN" || exit 1
exit 0

SUPPORT

Perldoc

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

perldoc SVN::Simple::Hook

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

• Search CPAN

  The default CPAN search engine, useful to view POD in HTML format.

  http://search.cpan.org/dist/SVN-Simple-Hook

• AnnoCPAN

  The AnnoCPAN is a website that allows community annotations of Perl module documentation.

  http://annocpan.org/dist/SVN-Simple-Hook

• CPAN Ratings

  The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

  http://cpanratings.perl.org/d/SVN-Simple-Hook

• CPANTS

  The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

  http://cpants.perl.org/dist/overview/SVN-Simple-Hook

• CPAN Testers

  The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.

  http://www.cpantesters.org/distro/S/SVN-Simple-Hook

• CPAN Testers Matrix

  The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

  http://matrix.cpantesters.org/?dist=SVN-Simple-Hook

• CPAN Testers Dependencies

  The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

  http://deps.cpantesters.org/?module=SVN::Simple::Hook

Bugs / Feature Requests

Please report any bugs or feature requests through the web interface at https://github.com/mjgardner/svn-simple-hook/issues. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/mjgardner/svn-simple-hook

git clone git://github.com/mjgardner/svn-simple-hook.git

AUTHOR

Mark Gardner <mjgardner@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by GSI Commerce.

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

cpanm SVN::Simple::Hook

perl -MCPAN -e shell
install SVN::Simple::Hook