Robin Smidsrød > App-GitHubPullRequest-0.0.6 > App::GitHubPullRequest

Download:
App-GitHubPullRequest-0.0.6.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.0.6   Source   Latest Release: App-GitHubPullRequest-0.3.1

NAME ^

App::GitHubPullRequest - Command-line tool to query GitHub pull requests

VERSION ^

version 0.0.6

SYNOPSIS ^

    $ prq
    $ prq list closed # not shown by default
    $ prq show 7      # also includes comments
    $ prq patch 7     # can be piped to colordiff if you like colors
    $ prq close 7
    $ prq open 7
    $ prq comment 7 "This is good stuff!"
    $ prq help

INSTALLATION ^

Install it by just typing in these few lines in your shell:

    $ curl -L http://cpanmin.us | perl - --self-upgrade
    $ cpanm App::GitHubPullRequest

COMMANDS ^

help

Displays some help.

list [<state>]

Shows all pull requests in the given state. State can be either open or closed. The default state is open. This is the default command if none is specified.

show <number>

Shows details about the specified pull request number. Also includes comments.

patch <number>

Shows the patch associated with the specified pull request number.

close <number>

Closes the specified pull request number.

open <number>

Reopens the specified pull request number.

comment <number> <text>

Creates a comment on the specified pull request with the specified text.

METHODS ^

run(@args)

Calls any of the other listed public methods with specified arguments. This is usually called automatically when you invoke prq.

CAVEATS ^

If you don't have git config github.user and git config github.password set in your git config, it will use unauthenticated API requests, which has a rate-limit of 60 requests. If you add your user + password info it should allow 5000 requests before you hit the limit.

You must be standing in a directory that is a git dir and that directory must have a remote that points to github.com for the tool to work.

SEE ALSO ^

SEMANTIC VERSIONING ^

This module uses semantic versioning concepts from http://semver.org/.

SUPPORT ^

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc App::GitHubPullRequest

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-app-githubpullrequest at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-GitHubPullRequest. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

http://github.com/robinsmidsrod/App-GitHubPullRequest

  git clone git://github.com/robinsmidsrod/App-GitHubPullRequest.git

AUTHOR ^

Robin Smidsrød <robin@smidsrod.no>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by Robin Smidsrød.

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

syntax highlighting: