Skip to content
Adding the missing "curator" permission to GitHub and automating compliance.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update CODEOWNERS Feb 20, 2019
auth Turn on validate customers and hmac by default Nov 21, 2018
config Fix issue with privatekey Oct 27, 2018
factory Add "config" package Oct 23, 2018
handler Correct --sign-off to --signoff in bot feedback May 13, 2019
types Add Private repo flag Feb 20, 2019
vendor Split auth package for clients Aug 31, 2018
.CUSTOMERS Add customer teamserverless Jun 7, 2019
.DEREK.yml Update .DEREK.yml Dec 4, 2017
.dockerignore Fix faas-cli build May 17, 2018
.gitignore Add "derek-*-key" to gitignore & amend GET.md Apr 2, 2018
.travis.yml Extend .travis.yml to build with script and push image Aug 17, 2018
CONTRIBUTING.md Update CONTRIBUTING.md May 10, 2018
Dockerfile Add "config" package Oct 23, 2018
GET.md Correct --sign-off to --signoff in bot feedback May 13, 2019
Gopkg.lock Split auth package for clients Aug 31, 2018
Gopkg.toml Split auth package for clients Aug 31, 2018
LICENSE Mention OpenFaaS Authors in license May 11, 2018
Makefile Allow slash alias all the time Feb 17, 2019
PRIVACY.md Add pro privacy statement Apr 19, 2019
README.md Core feature summary Feb 26, 2019
USER_GUIDE.md Add comma separated multi labels facility Apr 18, 2019
build.sh Extend .travis.yml to build with script and push image Aug 17, 2018
derek.yml Fix issue with privatekey Oct 27, 2018
main.go Add support for private repositories Feb 22, 2019
main_test.go Turn on validate customers and hmac by default Nov 21, 2018
sample_pull.json Add customer support Nov 13, 2017
secrets.example.yml Add "config" package Oct 23, 2018
stack.example.yml Add comma separated multi labels facility Apr 18, 2019

README.md

derek

Build Status OpenFaaS License: MIT

It's derek . Nice to meet you. I'd like to help you with Pull Requests and Issues on your GitHub project.

Please show support for the project and Star the repo.

From the team that brought you OpenFaaS - Serverless Functions Made Simple.

User guide / documentation

Core features

Derek is a bot for GitHub designed to reduce fatigue for maintainers and to delegate permissions to non-admin users in your community or team.

User guide

Find out what Derek can do you for your project, community and team including all available commands and configuration options: Read the user-guide

Get Derek

You can use a managed Derek bot or self-host your own on OpenFaaS. Start here: Get Derek.

How do I work?

I'm designed to be installed as a GitHub App, but don't worry - I don't need a lot of permissions. Just access to issues and Pull Requests will do.

I'm not a long-running daemon.. I'd get bored that way. I work with webhooks - so deploy me to a Serverless platform like OpenFaaS and forget about me. Just apply oil from time to time.

This is me in action with the DCO-checking feature. If I find a commit that isn't signed off then I'll let the contributor know in a comment. Normally they edit their commits and re-push within a few minutes after re-reading the message.

Inspiration for Derek

The idea for a bot that could comment on issues or respond to activity is from the docker/docker or Moby project's bot called Poule. It's a much more complex long-running daemon which uses Personal Access Tokens (so needs to run as a full GitHub login). Derek is much simpler (so hackable) and can be installed with granular permissions.

Live demo here

Our users

Some of our users include:

  • Docker / Moby:

https://github.com/moby/moby/issues/35736

  • OpenFaaS

https://github.com/openfaas/faas-cli/issues/85

Example: https://github.com/Subsurface-divelog/subsurface/pull/1748

See other users in our customers file

Backlog:

  • Derek as a managed GitHub App
  • Lock thread
  • Edit title
  • Toggle the DCO-feature

Future work:

  • Caching of customers / .DEREK.yml file
  • Observability of GitHub API Token rate limit
  • Add roles & actions
  • PR target branch checking (i.e. no PRs from master to master)

Maintainers and contributors

There are over a dozen contributors to Derek, but the following people have made the most impact.

Alex Ellis created Derek to automate project maintainer duties around licensing and to help bring granular permissions back to GitHub. Derek has empowered contributors in the OpenFaaS community to run and maintain the project without needing full write access. OpenFaaS contributors continue to improve Derek so they can get the job done without fuss.

Contributions

Please follow the OpenFaaS contribution guide.

You can’t perform that action at this time.