20 Mar 2017 03:14:45 UTC
- Distribution: App-GitHooks-Plugin-RequireTicketID
- Module version: v1.1.0
- Source (raw)
- Browse (raw)
- How to Contribute
- Clone repository
- Issues (1)
- KwaliteeBus factor: 0
- 100.00% Coverage
- License: perl_5
- Perl: v5.10.0
- Activity24 month
- Download (13.32KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionAUBERTG Guillaume Aubert
- CONFIGURATION OPTIONS
- COPYRIGHT & LICENSE
App::GitHooks::Plugin::RequireTicketID - Require a ticket ID in the commit message.
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.
This plugin supports the following options in the main section of your
project_prefixes = OPS, DEV extract_ticket_id_from_commit = /^($project_prefixes-\d+|--): /
A comma-separated list of project prefixes, in case you want to use this in
project_prefixes = OPS, DEV
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+|--): /
Code to execute as part of the commit-msg hook.
my $success = App::GitHooks::Plugin::RequireTicketID->run_commit_msg();
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.
You can find documentation for this module with the perldoc command.
You can also look for information at:
GitHub's request tracker
AnnoCPAN: Annotated CPAN documentation
<aubertg at cpan.org>.
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.
Module Install Instructions
To install App::GitHooks::Plugin::RequireTicketID, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install App::GitHooks::Plugin::RequireTicketID
For more information on module installation, please visit the detailed CPAN module installation guide.