DOKK / manpages / debian 12 / libpithub-perl / Pithub::Repos.3pm.en
Pithub::Repos(3pm) User Contributed Perl Documentation Pithub::Repos(3pm)

Pithub::Repos - Github v3 Repos API

version 0.01040

Provides access to Pithub::Repos::Actions.

Get information about a single branch.

    GET /repos/:owner/:repo/branches/:branch

Example:

    my $result = Pithub->new->branch(
        user => 'plu',
        repo => 'Pithub',
        branch => "master"
    );

See also branches to get a list of all branches.

List Branches

    GET /repos/:user/:repo/branches
    

Examples:

    my $repos  = Pithub::Repos->new;
    my $result = $repos->branches( user => 'plu', repo => 'Pithub' );
    

See also branch to get information about a single branch.

Rename a branch

    POST /repos/:user/:repo/branches/:branch/rename
    

Examples:

    my $b = Pithub::Repos->new;
    my $result = $b->rename_branch(
        user => 'plu',
        repo => 'Pithub',
        branch  => 'travis',
        data => { new_name => 'travis-ci' }
    );
    

Merge a branch

    POST /repos/:user/:repo/merges
    

Examples:

    my $b = Pithub::Repos->new;
    my $result = $b->rename_branch(
        user => 'plu',
        repo => 'Pithub',
        data => { base => 'master', head => 'travis', message => 'My commit message' }
    );
    

Provides access to Pithub::Repos::Collaborators.

Provides access to Pithub::Repos::Commits.

Provides access to Pithub::Repos::Contents.

List contributors

    GET /repos/:user/:repo/contributors
    

Examples:

    my $repos  = Pithub::Repos->new;
    my $result = $repos->contributors( user => 'plu', repo => 'Pithub' );
    

  • Create a new repository for the authenticated user.

        POST /user/repos
        

    Examples:

        my $repos  = Pithub::Repos->new;
        my $result = $repos->create( data => { name => 'some-repo' } );
        
  • Create a new repository in this organization. The authenticated user must be a member of this organization.

        POST /orgs/:org/repos
        

    Examples:

        my $repos  = Pithub::Repos->new;
        my $result = $repos->create(
            org  => 'CPAN-API',
            data => { name => 'some-repo' }
        );
        

Delete a repository.

    DELETE /repos/:owner/:repo

Provides access to Pithub::Repos::Downloads.

Provides access to Pithub::Repos::Forks.

Get a repo

    GET /repos/:user/:repo
    

Examples:

    my $repos  = Pithub::Repos->new;
    my $result = $repos->get( user => 'plu', repo => 'Pithub' );
    

Provides access to Pithub::Repos::Hooks.

Provides access to Pithub::Issues for this repo.

Provides access to Pithub::Repos::Keys.

List languages

    GET /repos/:user/:repo/languages
    

Examples:

    my $repos  = Pithub::Repos->new;
    my $result = $repos->languages( user => 'plu', repo => 'Pithub' );
    

  • List repositories for the authenticated user.

        GET /user/repos
        

    Examples:

        my $repos  = Pithub::Repos->new;
        my $result = $repos->list;
        
  • List public repositories for the specified user.

        GET /users/:user/repos
        

    Examples:

        my $repos  = Pithub::Repos->new;
        my $result = $repos->list( user => 'plu' );
        
  • List repositories for the specified org.

        GET /orgs/:org/repos
        

    Examples:

        my $repos  = Pithub::Repos->new;
        my $result = $repos->list( org => 'CPAN-API' );
        

Provides access to Pithub::Markdown setting the current repository as the default context. This also sets the mode to default to 'gfm'.

Provides access to Pithub::PullRequests.

Provides access to Pithub::Repos::Releases.

Provides access to Pithub::Repos::Starring.

Provide access to Pithub::Repos::Stats.

Provide access to Pithub::Repos::Statuses.

List Tags

    GET /repos/:user/:repo/tags
    

Examples:

    my $repos  = Pithub::Repos->new;
    my $result = $repos->tags( user => 'plu', repo => 'Pithub' );
    

List Teams

    GET /repos/:user/:repo/teams
    

Examples:

    my $repos  = Pithub::Repos->new;
    my $result = $repos->teams( user => 'plu', repo => 'Pithub' );
    

Edit

    PATCH /repos/:user/:repo
    

Examples:

    # update a repo for the authenticated user
    my $repos  = Pithub::Repos->new;
    my $result = $repos->update(
        repo => 'Pithub',
        data => { description => 'Github API v3' },
    );
    

Provides access to Pithub::Repos::Watching.

Johannes Plunien <plu@cpan.org>

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.

2022-10-04 perl v5.34.0