Probot: protector-app-bot

A GitHub App built with Probot that enables protection on main branch of a newly created repository within an organization.

Table of Contents generated with DocToc

• Install
• Features
  • Prerequisites
• Getting Started
  • Basic Setup
• Contributing
• License

Install

Features

• Ensure protection is enabled on the main branch.
• Automatically add protection rule for atleast one code review before pull request can be merged.
• @todo Configure reviewers.
• @todo Configurable master branch.

Prerequisites

• At least a README.md file needs to be present during new repository creation to trigger a main branch creation.
• If organization is on a Free Plan then the repository needs to be Public.

Getting Started

⭐ Star this project (Highly recommended, starred users may receive priority over regular users)

Basic Setup

• Just install Protector-App-Bot app.

Protector-app-bot will automatically watch for new repository creation with main branch and enable the minimum code review protection on the main branch.

Contributing

If you have suggestions for how protector-app-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

ISC © 2022 vinayski