1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
package Git::Raw::Tag;
$Git::Raw::Tag::VERSION = '0.87';
use strict;
use warnings;
use Git::Raw;
=head1 NAME
Git::Raw::Tag - Git tag class
=head1 VERSION
version 0.87
=head1 SYNOPSIS
use Git::Raw;
# open the Git repository at $path
my $repo = Git::Raw::Repository -> open($path);
# retrieve user's name and email from the Git configuration
my $config = $repo -> config;
my $name = $config -> str('user.name');
my $email = $config -> str('user.email');
# create a new Git signature
my $me = Git::Raw::Signature -> now($name, $email);
# create a new tag
my $tag = $repo -> tag(
'v0.1', 'Initial version', $me, $repo -> head -> target
);
=head1 DESCRIPTION
A L<Git::Raw::Tag> represents an annotated Git tag.
B<WARNING>: The API of this module is unstable and may change without warning
(any change will be appropriately documented in the changelog).
=head1 METHODS
=head2 create( $repo, $name, $msg, $tagger, $target )
Create a new annotated tag given a name, a message, a
L<Git::Raw::Signature> representing the tagger and a target object.
=head2 lookup( $repo, $id )
Retrieve the tag corresponding to C<$id>. This function is pretty much the same
as C<$repo-E<gt>lookup($id)> except that it only returns tags. If the tag
doesn't exist, this function will return C<undef>.
=head2 owner( )
Retrieve the L<Git::Raw::Repository> owning the tag.
=head2 foreach( $repo, $callback, [$type] )
Run C<$callback> for every tag in the repo. The callback receives a tag object,
which will either a be a L<Git::Raw::Tag> object for annotated tags, or a
L<Git::Raw::Reference> for lightweight tags. C<$type> may be C<"all">,
C<"annotated"> or C<"lightweight">. If C<$type> is not specified or is C<undef>,
all tags will be returned. A non-zero return value stops the loop.
=head2 delete( )
Delete the tag. The L<Git::Raw::Tag> object must not be accessed afterwards.
=head2 id( )
Retrieve the id of the tag, as a string.
=head2 name( )
Retrieve the name of the tag.
=head2 message( )
Retrieve the message of the tag.
=head2 tagger( )
Retrieve the L<Git::Raw::Signature> representing the tag's tagger. If there
is no tagger, C<undef> will be returned.
=head2 target( )
Retrieve the target object of the tag.
=head1 AUTHOR
Alessandro Ghedini <alexbio@cpan.org>
Jacques Germishuys <jacquesg@striata.com>
=head1 LICENSE AND COPYRIGHT
Copyright 2012 Alessandro Ghedini.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
1; # End of Git::Raw::Tag
|
