The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Pithub::GitData::Tags - Github v3 Git Data Tags API

VERSION

version 0.01003

METHODS

create

  • Create a Tag

    Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you simply have to create the reference - this call would be unnecessary.

        POST /repos/:user/:repo/git/tags

    Examples:

        # TODO: verify I got the parameters right:
        # 'tagger.name' vs tagger.name
        $result = $p->git_data->tags->create(
            user => 'plu',
            repo => 'Pithub',
            data => {
                tagger => {
                    date  => '2010-04-10T14:10:01-07:00',
                    email => 'plu@cpan.org',
                    name  => 'Johannes Plunien',
                },
                message => 'Tagged v0.1',
                object  => '827efc6d56897b048c772eb4087f854f46256132',
                tag     => 'v0.1',
                type    => 'commit',
            }
        );

Parameters in data hashref:

Parameters

  • tag: String of the tag

  • message: String of the tag message

  • object: String of the SHA of the git object this is tagging

  • type: String of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.

  • tagger.name: String of the name of the author of the tag

  • tagger.email: String of the email of the author of the tag

  • tagger.date: Timestamp of when this object was tagged

get

  • Get a Tag

        GET /repos/:user/:repo/git/tags/:sha

    Examples:

        $result = $p->git_data->tags->get(
            user => 'plu',
            repo => 'Pithub',
            sha  => 'df21b2660fb6',
        );

AUTHOR

Johannes Plunien <plu@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Johannes Plunien.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

1 POD Error

The following errors were encountered while parsing the POD:

Around line 105:

Non-ASCII character seen before =encoding in 'we’re'. Assuming UTF-8