Skip to content

redwoodjs/github-bot

Repository files navigation

GitHub Bot

Redwood's GitHub bot.

Usage

Although this repo is named github-bot, it has a script that you can run locally to validate all of redwoodjs/redwood's open issues and pull requests:

yarn validate

You'll need to a personal-access token (PAT—provision one here) set to GITHUB_TOKEN in your env with the appropriate permissions to run this.

validate.mov

The github.ts function does as much as it can to process issues and pull requests as they're opened, and responds to all the events it can to keep them in sync. But there's just some events—like an issue being linked to a pull request—that it can't listen to. And even if it could listen to everything, things will still get out of sync anyway.

That's where this script comes in: it'll sort out most of the inconsistencies on its own, and will prompt you to handle issues or pull requests that require your attention (because they're unprioritized or stale).

Architecture

This repo is basically just a backend right now. It makes heavy use of Redwood's services.

All the logic for processing a webhook is in github.ts. That function mostly contains routing logic—it calls out to the services as much as it can.

Contributing

Contributing to this is a bit tricky. To test your changes, you have to fork this repo, make a GitHub app, and install it on one of your repos.

About

RedwoodJS-bot has gotta bot

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published