—package
Git::Raw::Tag;
{
$Git::Raw::Tag::VERSION
=
'0.30'
;
# TRIAL
}
use
strict;
use
warnings;
use
Git::Raw;
=head1 NAME
Git::Raw::Tag - Git tag class
=head1 VERSION
version 0.30
=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 C<Git::Raw::Tag> represents a 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 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.
=head2 foreach( $repo, $callback )
Run C<$callback> for every tag in the repo. The callback receives a tag object.
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 string.
=head2 name( )
Retrieve the name of the tag.
=head2 message( )
Retrieve the message of the tag.
=head2 tagger( )
Retrieve the C<Git::Raw::Signature> representing the tag's tagger.
=head2 target( )
Retrieve the target object of the tag.
=head1 AUTHOR
Alessandro Ghedini <alexbio@cpan.org>
=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