1App::GitHooks::CommitMeUssseargeC(o3n)tributed Perl DocuAmpepn:t:aGtiitoHnooks::CommitMessage(3)
2
3
4

NAME

6       App::GitHooks::CommitMessage - A git commit message.
7

VERSION

9       Version 1.9.0
10

METHODS

12   new()
13               my $commit_message = App::GitHooks::CommitMessage->new(
14                       app     => $app,
15                       message => $message,
16               );
17
18       Arguments:
19
20       •   app (mandatory)
21
22           An "App::GitHook" instance.
23
24       •   message (mandatory)
25
26           The commit message.
27
28   update_message()
29       Update the commit message.
30
31               my $success = $commit_message->update_message( $new_message );
32
33   get_lines()
34       Return an arrayref of the lines that will be included in the commit
35       message, excluding blank lines and comments.
36
37               my $lines = $commit_message->get_lines(
38                       include_comments    => $include_comments,    # default: 0
39                       include_blank_lines => $include_blank_lines, # default: 1
40               );
41
42   get_summary()
43       Return the first line of the commit message.
44
45               my $summary = $commit_message->get_summary();
46
47   is_empty()
48       Indicate whether a commit message is empty, after excluding comment
49       lines and blank lines.
50
51               my $is_empty = $commit_message->is_empty();
52
53   get_ticket_id()
54       Extract and return a ticket ID from the commit message.
55
56               my $ticket_id = $commit_message->get_ticket_id();
57
58   has_changed()
59       Return whether the message has changed since the object was created.
60
61               my $has_changed = $commit_message->has_changed();
62

ACCESSORS

64   get_original_message()
65       Return the original message that was provided when the object was
66       created.
67
68               my $original_message = $commit_message->get_original_message();
69
70   get_message()
71       Return the commit message itself.
72
73               my $message = $commit_message->get_message();
74
75   get_app()
76       Return the parent "App::GitHooks" object.
77
78               my $app = $commit_message->get_app();
79

BUGS

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

SUPPORT

87       You can find documentation for this module with the perldoc command.
88
89               perldoc App::GitHooks::CommitMessage
90
91       You can also look for information at:
92
93       •   GitHub's request tracker
94
95           <https://github.com/guillaumeaubert/App-GitHooks/issues>
96
97       •   AnnoCPAN: Annotated CPAN documentation
98
99           <http://annocpan.org/dist/app-githooks>
100
101       •   CPAN Ratings
102
103           <http://cpanratings.perl.org/d/app-githooks>
104
105       •   MetaCPAN
106
107           <https://metacpan.org/release/App-GitHooks>
108

AUTHOR

110       Guillaume Aubert <https://metacpan.org/author/AUBERTG>, "<aubertg at
111       cpan.org>".
112

114       Copyright 2013-2017 Guillaume Aubert.
115
116       This code is free software; you can redistribute it and/or modify it
117       under the same terms as Perl 5 itself.
118
119       This program is distributed in the hope that it will be useful, but
120       WITHOUT ANY WARRANTY; without even the implied warranty of
121       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LICENSE
122       file for more details.
123
124
125
126perl v5.32.1                      2021-01-26   App::GitHooks::CommitMessage(3)
Impressum