The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
SVN-Hooks-0.16.48
River stage zero No dependents
++
/ SVN::Hooks::JiraAcceptance

NAME

SVN::Hooks::JiraAcceptance - Integrate Subversion with the JIRA ticketing system.

SYNOPSIS

This SVN::Hooks plugin was derived from version 1.3 of the JIRA Commit Acceptance Plugin by ferenc.kiss@midori.hu.

When enabled, it requires that any commits affecting some parts of the repository structure must make reference to valid JIRA issues in the commit log message. JIRA issues are referenced by their ids which consists of a sequence of uppercase letters separated by an hyfen from a sequence of digits. E.g., CDS-123, RT-1, and SVN-97.

It's active in the pre-commit hook.

It's configured by the following directives.

JIRA_CONFIG(BASEURL, LOGIN, PASSWORD)

This directive specify how to connect to the JIRA server by specifying its base URL and the login credentials of a user who has browsing rights.

JIRA_LOG_MATCH(REGEXP, MESSAGE)

By default the JIRA references are looked for in the commit log message as a whole. Sometimes this can be suboptimal because the user can introduce in the message some text that inadvertently looks like a JIRA reference whithout being so.

With this directive, the log message is matched against the REGEXP and only the first group matched (i.e., the part of the message captured by the first parenthesis ($1)) is used to look for JIRA references. Moreover, you can pass a help MESSAGE that is shown to the user in case the JIRA test fails.

        JIRA_LOG_MATCH(
            qr/^\[([^\]]+)\]/,
            "The JIRA references must be inside brackets at the beginning of the message.",
        );

JIRA_ACCEPTANCE(REGEXP, PROJECT_KEYS)

This directive tells what parts of the repository structure must be integrated with what JIRA projects.

During a commit, all files being changed are tested against the REGEXP. If at least one of them matches, then the log message must contain references to the PROJECT_KEYS.

PROJECT_KEYS can contain multiple comma-separated JIRA project keys like 'TST,ARP'. If you specify multiple keys, the commit will be accepted if at least one project listed accepts it. Or you can specify '*' to force using the global commit acceptance settings if you don't want to specify any exact project key.

        JIRA_ACCEPTANCE(qr/^(trunk|branches/fix)/ => 'CDS,TST');

AUTHOR

Gustavo Chaves, <gnustavo@cpan.org>

BUGS

Please report any bugs or feature requests to bug-svn-hooks-jiraacceptance 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:

ACKNOWLEDGEMENTS

To ferenc.kiss@midori.hu, author of the JIRA Commit Acceptance plugin at http://svn.atlassian.com/svn/public/contrib/jira/jira-commitacceptance-plugin/jars/jira-commitacceptance-plugin-1.3-client-scripts.zip

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.