Giter Club home page Giter Club logo

drill-sergeant's Introduction

Drill Sergeant

Build Status

Keep track and get notified when github pull requests become stale. This is particularly useful for teams utilizing the github flow. Drillsergeant will send a notify of stale PRs via:

  • Email
  • Slack
  • Github (attaching a stale label to the PR)

Screen shot

Install

npm install -g drill-sergeant

Run

This is intended to be run via a crontab or other scheduled task runner.

A typical command line run:

$ GITHUB_TOKEN='<your token here>' drillsergeant -e "youremail@address" -r "user/repository,user/repository2"

If you want it to label the PR as stale:

$ drillsergeant -l -r "user/repository"

If you want to send it to slack:

$ drillsergeant -r "user/repository" --slack-webhook https://your-slack-channel-webhook-url

Configuration

The environment variable GITHUB_TOKEN must be set with a valid github oauth token in order to read the pull requests. For attaching labels, the token needs to have write access to the repo being scanned.

Options

See drillsergeant -h for all available options.

drill-sergeant's People

Contributors

cjsaylor avatar dependabot[bot] avatar jrbasso avatar rnalexander avatar young-steveo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

drill-sergeant's Issues

Update dependencies

$ sudo npm update -g drill-sergeant
npm WARN deprecated [email protected]: 'github' has been renamed to '@octokit/rest' (https://git.io/vNB11)
npm WARN deprecated [email protected]: All versions below 4.0.1 of Nodemailer are deprecated. See https://nodemailer.com/status/
npm WARN deprecated [email protected]: This project is unmaintained
npm WARN deprecated [email protected]: This project is unmaintained
/usr/bin/drillsergeant -> /usr/lib/node_modules/drill-sergeant/bin/drillsergeant.js
- [email protected] node_modules/drill-sergeant/node_modules/jsonify
- [email protected] node_modules/drill-sergeant/node_modules/json-stable-stringify
/usr/lib
└── [email protected]

Add an npm ignore file and republish

Ignore all unnecessary files for running the application. This includes tests/, tasks/, and everything but index.js and package.json in the root.

Add a "verbose" option.

For example, when no PRs are found to be stale, don't output a message to stdout unless a verbose flag is provided on the command line.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.