https://github.com/mallozup/doghub

a functional stale bot for Github Issue and PRs.
https://github.com/mallozup/doghub

bot clojure data-driven functional-programming github monitor stale

Last synced: about 1 month ago
JSON representation

a functional stale bot for Github Issue and PRs.

• Host: GitHub
• URL: https://github.com/mallozup/doghub
• Owner: MalloZup
• License: gpl-3.0
• Created: 2019-07-29T21:34:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-07T07:52:02.000Z (over 5 years ago)
• Last Synced: 2024-10-30T08:41:36.949Z (3 months ago)
• Topics: bot, clojure, data-driven, functional-programming, github, monitor, stale
• Language: Clojure
• Homepage:
• Size: 41 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# doghub

Doghub monitors stale Issues and Pull Requests for your different Github projects in a private and centralized manner. You can use doghub for both your personal and professional projects.

# Table of Contents

* [Why use doghub?](#why-use-doghub)

* [Main features](#main-features)

* [Quickstart](#quickstart)

## Why use doghub?

- Allows maintainers to be independent without the need for an external service in their repo (instead you can use a token and manage the daemon yourself on your server)

- Offers full centralized control over your project(s)

## Main features:

1. Doghub will comment on stale Issues and PRs. You can configure a limit for the number of days a PR or an issue can remain inactive on the repo. (At present, this is the only feature in doghub. In the future, there is a plan to support a custom handler, which will let the user decide to apply a specific action for stale issues (e.g., close, comment, label etc.))

2. Doghub can work either with a list of repositories or a list of organisations. (An organisation can own multiple repositories, while a repository relates to one project)

## Quickstart

1) Create  `doghub.edn` file:

```

{

  :github-config {

     :token "my-token"

  }

    

  :repositories ["MalloZup/missile", "MalloZup/doghub"]

  	;; the list of Github repositories that you want monitored in terms of stale Issues and PRs

  :issue-days 130 

  	;; the number of days that an issue can remain inactive

  :prs-days 2 

  	;; the number of days for Pull-requests to remain unactioned. PRs older than this will require action.

 ;; by default doghub will create a comment on the issue or PR. You can customize the prefix message.

 :prefix-msg "autogenerated with https://github.com/MalloZup/doghub: "

 ;; the message is composed of prefix-msg + std-msg.  std-msg will be " the PR/issue is older than 'x'(10) days. 

  

 ;; the bot will just update the comments.  RATE-LIMITING will be logged in case requests exceed a specified limit.

}

```

Instead of a list of repositories you can also use a list of organisations (see the `doghub.edn.example` config file).

2) Start the daemon:

```java -jar doghub-VERSION-standalone.jar```

The configuration file should be in the same dir where you start the daemon. Otherwise use the ENV variable `CONFIG_FILE_PATH` to setup a config file from another location.

If you use doghub, feel free to add a PR of your project!