pr-summary

pr-summary is a command to summarize merged Pull Requests between specified refs.

Getting Started

Prerequisites

node.js 6.X.

Install

This package provided as npm package. You can install this command by npm install -g pr-summary
Get your GitHub access token.
Set the access token as Environment Variable GITHUB_TOKEN

Commands

 $ prs --help

  Usage: prs [options] [command]

  Commands:

    prepare-release   Create to prepare release PR
    pr-info           List PRs in specified PR
    help [cmd]        display help for [cmd]

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

pr-info(default)

  Usage: prs pr-info <owner> <repo> <number>

  Options:

    -h, --help  output usage information

  Arguments:

    owner:  Repository owner
    repo:   Repository name
    number: Pull Request number

  Example:

    prs pr-info kompiro pr-summary 3

prepare-release

  Usage: prs prepare-release <owner> <repo> <base> <head>

  Options:

    -h, --help  output usage information

  Arguments:

    owner:  Repository owner
    repo:   Repository name
    base:   Base branch to merge [ex: master]
    base:   Head branch to merge [ex: develop]

  Example:

    prs prepare-release kompiro pr-summary master develop

daily-report

  Usage: prs-daily-report <owner> <repo> [user] [date]

  Options:

    -h, --help  output usage information

  Arguments:

    owner:  Repository owner
    repo:   Repository name
    user:   User name(optional)
    date:   Filter to specify target date(optional)

  Example:

    prs-pr-daily-report kompiro pr-summary kompiro (today)

Running the tests

npm test

And coding style tests

This command contains .eslintrc.js. You can check the style by eslint

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Hiroki Kondo - Initial work - kompiro

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

marcello3d / pr-summary Goto Github PK

pr-summary's Introduction