1App::GitHooks::Utils(3)User Contributed Perl DocumentatioAnpp::GitHooks::Utils(3)
2
3
4

NAME

6       App::GitHooks::Utils - Support functions for App::GitHooks and its
7       plugins.
8

VERSION

10       Version 1.9.0
11

FUNCTIONS

13   get_project_prefixes()
14       Get an arrayref of valid project prefixes.
15
16               my $project_prefixes = App::GitHooks::Utils::get_project_prefixes( $app );
17
18       Arguments:
19
20       •   $app
21
22           An "App::GitHooks" instance.
23
24   get_project_prefix_regex()
25       Return a non-capturing regex that will match all the valid project
26       prefixes.
27
28               my $project_prefix_regex = App::GitHooks::Utils::get_project_prefix_regex( $app );
29
30       Arguments:
31
32       •   $app
33
34           An "App::GitHooks" instance.
35
36   get_ticket_id_from_commit_regex()
37       Return a regex that will extract a ticket ID from a commit message, if
38       it exists.
39
40               my $ticket_id_regex = App::GitHooks::Utils::get_ticket_id_from_commit_regex( $app );
41
42       Arguments:
43
44       •   $app
45
46           An "App::GitHooks" instance.
47
48   get_ticket_id_from_branch_name()
49       Return the ticket ID derived from the name of the current branch for
50       this repository.
51
52               my $ticket_id = App::GitHooks::Utils::get_ticket_id_from_branch_name( $app );
53
54       Arguments:
55
56       •   $app
57
58           An "App::GitHooks" instance.
59

BUGS

61       Please report any bugs or feature requests through the web interface at
62       <https://github.com/guillaumeaubert/App-GitHooks/issues/new>.  I will
63       be notified, and then you'll automatically be notified of progress on
64       your bug as I make changes.
65

SUPPORT

67       You can find documentation for this module with the perldoc command.
68
69               perldoc App::GitHooks::Utils
70
71       You can also look for information at:
72
73       •   GitHub's request tracker
74
75           <https://github.com/guillaumeaubert/App-GitHooks/issues>
76
77       •   AnnoCPAN: Annotated CPAN documentation
78
79           <http://annocpan.org/dist/app-githooks>
80
81       •   CPAN Ratings
82
83           <http://cpanratings.perl.org/d/app-githooks>
84
85       •   MetaCPAN
86
87           <https://metacpan.org/release/App-GitHooks>
88

AUTHOR

90       Guillaume Aubert <https://metacpan.org/author/AUBERTG>, "<aubertg at
91       cpan.org>".
92

94       Copyright 2013-2017 Guillaume Aubert.
95
96       This code is free software; you can redistribute it and/or modify it
97       under the same terms as Perl 5 itself.
98
99       This program is distributed in the hope that it will be useful, but
100       WITHOUT ANY WARRANTY; without even the implied warranty of
101       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE
102       file for more details.
103
104
105
106perl v5.32.1                      2021-01-26           App::GitHooks::Utils(3)
Impressum