Skip to content

A configurable GitHub Probot App which checks whether a submitted bug reports contains necessary information

License

Notifications You must be signed in to change notification settings

RussKie/archivarius-bot

Repository files navigation

archivarius-bot

A configurable GitHub Probot App that ensures bug reports contains necessary information.

The app has been built for an integration with Git Extensions and NBug error report submissions, but with few tweaks can be turned into a general purpose duplicate checker bot.

Demo

Usage

  • You can deploy our Github App manually. For example to Glitch (guide from Andrew Lock)
  • Then, you can create a custom configuration file at .github/archivarius.yml. If this file doesn't exists, default settings will be used:
# Label name and color to set, when potential duplicates are detected
issueLabel: "status: incorrectly filled template"

# Comment to post when potential duplicates are detected
referenceComment: >
  Please fill in all required information and ping us back to re-open.

Deploying

If you would like to run your own instance of this app, see the docs for deployment. This app requires both Issues – Read & Write and Single File – Read (.github/archivarius.yml) permissions & events.

Setup

# Install dependencies
npm install

# Run the bot
npm run dev

Contributing

If you have suggestions for how archivarius-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

ISC © 2019 Igor Velikorossov (https://github.com/RussKie/archivarius-bot)

About

A configurable GitHub Probot App which checks whether a submitted bug reports contains necessary information

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published