Skip to content

An experimental bot posting pending team review requests to Zulip. And a Google Cloud Function turning Github webhooks into Zulip messages requesting review.

License

Notifications You must be signed in to change notification settings

reload/reviewbot

Repository files navigation

Reviewbot

MIT Licensed Go

An experimental bot that posts pending team review requests to Zulip, plus a Google Cloud Function that turns GitHub webhooks into Zulip messages requesting reviews.

Overview

Reviewbot bridges the gap between GitHub pull requests and your team’s Zulip chat. Whenever code is ready for review, Reviewbot notifies your Zulip stream or topic, making it easier for teams to track PRs awaiting attention.

  • GitHub → Zulip Integration: Converts webhooks into Zulip messages when PRs need review.
  • Cloud Function Support: Deployable as a Google Cloud Function for scalable automation.
  • Team Notifications: Ensures timely notifications for code review requests.

Features

  • Monitors GitHub repositories for new or pending PRs.
  • Posts relevant review requests in designated Zulip streams/topics.
  • Intended for team environments to reduce review friction.
  • Written in Go for performance and cloud-native deployment.

Requirements

  • Go (for development, building, or local running)
  • GitHub repository with webhook permissions
  • Zulip account, stream, and API information
  • Google Cloud Functions (optional; for serverless deployment)

Installation

  1. Clone the Repo

    git clone https://github.com/reload/reviewbot.git
    cd reviewbot
  2. Configure

    • Set up your GitHub webhook to point to your Reviewbot endpoint.
    • Provide Zulip bot credentials and stream configuration.
  3. Deploy

    • As a Google Cloud Function: Follow Google’s deployment instructions and provide the proper environment variables.
    • Locally: Run with go run main.go (additional configuration may be needed).

Usage

  • When a pull request is created or marked ready for review in your GitHub repository:
    • Reviewbot receives the webhook, parses it, and posts a structured message in your Zulip stream/topic requesting review from assigned users or teams.

License

MIT © Reload


Experimental project. Contributions and feedback welcome!

About

An experimental bot posting pending team review requests to Zulip. And a Google Cloud Function turning Github webhooks into Zulip messages requesting review.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 3

  •  
  •  
  •