The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-GitHooks-Plugin-RequireTicketID-v1.1.0
River stage zero No dependents
++
/ App::GitHooks::Plugin::RequireTicketID

NAME

App::GitHooks::Plugin::RequireTicketID - Require a ticket ID in the commit message.

DESCRIPTION

If you are using a ticketing system, it is very useful to make sure that all your commit messages include a ticket ID to provide more context into why the code is being changed.

VERSION

Version 1.1.0

CONFIGURATION OPTIONS

This plugin supports the following options in the main section of your .githooksrc file.

        project_prefixes = OPS, DEV
        extract_ticket_id_from_commit = /^($project_prefixes-\d+|--): /

project_prefixes

A comma-separated list of project prefixes, in case you want to use this in extract_ticket_id_from_commit or extract_ticket_id_from_branch.

        project_prefixes = OPS, DEV

extract_ticket_id_from_commit

A regular expression with _one_ capturing group that will be applied to the first line of a commit message to extract the ticket ID referenced, if there is one.

        extract_ticket_id_from_commit = /^($project_prefixes-\d+|--): /

METHODS

run_commit_msg()

Code to execute as part of the commit-msg hook.

  my $success = App::GitHooks::Plugin::RequireTicketID->run_commit_msg();

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/guillaumeaubert/App-GitHooks-Plugin-RequireTicketID/issues/new. 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 App::GitHooks::Plugin::RequireTicketID

You can also look for information at:

AUTHOR

Guillaume Aubert, <aubertg at cpan.org>.

COPYRIGHT & LICENSE

Copyright 2013-2017 Guillaume Aubert.

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

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE file for more details.