/gitstream

/:\ gitStream - Workflow automation for the code review process. Use YAML to automatically assign reviewers, apply PR labels, auto-merge PRs, and more.

Primary LanguagePythonApache License 2.0Apache-2.0

/:\ gitStream

gitStream is a workflow automation tool that enables you to use YAML configuration files to optimize your code review process. Add context to PRs, find code experts for reviews, and automate the merge process to maximize developer productivity.

If you like gitStream, please give this repo a star! ⭐ It helps us spread the word.

Main Features

Automated Change Requests

Reduce code review noise by catching issues before anyone invests precious time. Flag deprecated components, missing data objects, off-limits code, and other problems that need to be addressed before assigning code reviewers.

Review Assignment

Identifying the correct people to review a PR can take time, particularly for complex projects and repos requiring deep expertise. Assign code experts to review complex PRs, notify your security team about sensitive changes, and automatically assign reviewers based on the contents of the PR.

Auto-Merge PRs

Not all PRs need extensive review policies that loop in multiple experts. gitStream lets you auto-merge safe changes, small fixes, PRs from trusted teams, and anything else you want to unblock the review process to keep your team focused on their work.

Contextual Labels

Reduce the mental burden of code reviews with labels that provide a high degree of context. Indicate an estimated time to review or flag potential issues with Jira information, missing tests, deleted files, and more.

Install

How to install gitStream.

Usage

Contribute

Updates

Subscribe to gitStream Feature Announcements.

Local Documentation Server Setup

To run the documentation server locally using Python3, follow these steps:

  1. Create a virtual environment named .venv using the command python -m venv .venv
  2. Activate the virtual environment by running the command . ./.venv/bin/activate
  3. Install the required packages by executing pip install -r requirements.txt
  4. Start the server by running mkdocs serve

The local documentation server should now be running at http://127.0.0.1:8000/.