stebje / MasterBranchGuard

🛡️ A GitHub App that automatically protects the master branch when new repositories are created.

Automatically protect your default branch

Intro

MasterBranchGuard is a GitHub App built with Probot that automatically protects the master branch when new repositories are created.

An issue is created within the repository with an @mention and details on the protections added.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need;

• An organization that can be used to trigger events to the app
• Node.js

Installing

Option 1 (for dev/testing on local machine)

1. For documentation on setting up a local environment please see Probot docs

2. Run these commands in your favorite terminal

# Download or clone repo to local repository
git clone https://github.com/steffenba/MasterBranchGuard.git

# Navigate to local repository and install dependencies from terminal
npm install

# Run the bot
npm start
# or
npm run dev

Option 2 (for direct install to organization)

(Note: Not yet possible, pending deployment to Probot featured apps)

1. Go to the app's page on Probot and follow the instructions

2. Follow the instructions and make sure you select the organization(s) that you want MasterBranchGuard added to

Contributing

If you have suggestions for how MasterBranchGuard 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.

Authors

Steffen Bjerkenås - stebje

License

ISC © 2020 Steffen Bjerkenås [e-mail]

Acknowledgments

Logo created via https://www.freelogodesign.org/

Probot community

Future improvements

See FUTURE_IMPROVEMENTS.md