https://github.com/megamanics/protector-app-bot

:octocat: ProBot App for automating protected branches
https://github.com/megamanics/protector-app-bot

bot github probot

Last synced: 14 days ago
JSON representation

:octocat: ProBot App for automating protected branches

• Host: GitHub
• URL: https://github.com/megamanics/protector-app-bot
• Owner: megamanics
• Created: 2022-02-13T23:55:11.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-11T14:26:23.000Z (almost 3 years ago)
• Last Synced: 2026-04-30T16:27:57.410Z (about 2 months ago)
• Topics: bot, github, probot
• Language: JavaScript
• Homepage: https://github.com/apps/protector-app-bot
• Size: 1.14 MB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Probot: protector-app-bot

[![Test](https://github.com/vinayski/protector-app-bot/actions/workflows/testvgh.yml/badge.svg)](https://github.com/vinayski/protector-app-bot/actions/workflows/testvgh.yml)

[![CodeQL](https://github.com/megamanics/protector-app-bot/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/megamanics/protector-app-bot/actions/workflows/codeql-analysis.yml)

> A GitHub App built with [Probot](https://github.com/probot/probot) that enables protection on main branch of a newly created repository within an organization.

**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [Install](#install)

- [Features](#features)

  - [Prerequisites](#prerequisites)

- [Getting Started](#getting-started)

  - [Basic Setup](#basic-setup)

- [Contributing](#contributing)

- [License](#license)

## Install

[![button](https://dabuttonfactory.com/button.png?t=Install+Protector-app-bot&f=Roboto-Bold&ts=26&tc=fff&tshs=1&tshc=000&hp=45&vp=20&c=11&bgt=unicolored&bgc=15d798)](https://github.com/apps/protector-app-bot/installations/new)

[![button](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button.svg)](https://glitch.com/edit/#!/remix/probot-hello-world)

[![button](https://dabuttonfactory.com/button.png?t=Settings&f=Roboto-Bold&ts=26&tc=fff&tshs=1&tshc=000&hp=45&vp=20&c=11&bgt=unicolored&bgc=15d798)](https://github.com/settings/apps/protector-app-bot)

## 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](https://github.com/vinayski/protector-app-bot)** (Highly recommended, starred users may receive priority over regular users)

### Basic Setup

 - Just install **[ Protector-App-Bot app](https://github.com/apps/protector-app-bot/installations/new)**.

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](CONTRIBUTING.md).

## License

[ISC](LICENSE) © 2022 vinayski