/ 
SVN-Hooks-0.13.12
River stage zero No dependents
/ SVN::Hooks::UpdateConfFile

NAME

SVN::Hooks::UpdateConfFile - Maintain the repository configuration versioned.

SYNOPSIS

This SVN::Hooks plugin allows you to maintain the repository configuration files under version control.

The repository configuration is usually kept in the directory conf under the directory where the repository was created. In a brand new repository you see there the files authz, passwd, and svnserve.conf. It's too bad that these important files are usually kept out of any version control system. This plugin tries to solve this problem allowing you to keep these files versioned under the same repository where they are used.

It's active in the pre-commit and the post-commit hooks.

It's configured by the following directive.

UPDATE_CONF_FILE(FROM, TO, @ARGS)

This directive tells that the file FROM kept under version control must be copied to TO, a directory relative to the /repo/conf directory in the server, after a succesful commit.

The optional @ARGS must be a sequence of pairs like these:

validator => ARRAY or CODE

A validator is a function or a command (specified by an array of strings that will be passed to the shell) that will check the contents of FROM in the pre-commit hook to see if it's valid. If there is no validator, the contents are considered valid.

generator => ARRAY or CODE

A generator is a function or a command that will transform the contents of FROM in the post-commit hook before copying it to TO. If there is no generator, the contents are copied as is.

rotate => NUMBER

By default, after each succesful commit the TO file is overwriten by the new contents of FROM. With this option, the last NUMBER versions of TO are kept on disk with numeric suffixes ranging from .0 to .NUMBER-1. This can be useful, for instance, in case you manage to commit a wrong authz file that denies any subsequent commit.

UPDATE_CONF_FILE(
    'conf/authz' => 'authz',
    validator 	 => ['/usr/local/bin/svnauthcheck'],
    generator 	 => ['/usr/local/bin/authz-expand-includes'],
    rotate       => 2,
);

UPDATE_CONF_FILE(
    'conf/svn-hooks.conf' => 'svn-hooks.conf',
    validator 	 => ['/usr/bin/perl', '-c'],
    rotate       => 2,
);

AUTHOR

Gustavo Chaves, <gnustavo@cpan.org>

BUGS

Please report any bugs or feature requests to bug-svn-hooks-updaterepofile at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=SVN-Hooks. 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 SVN::Hooks

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2008 CPqD, all rights reserved.

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