Giter Club home page Giter Club logo

automate-branch-rules-cli's Introduction

Automate โžฐ Branch Rules (CLI)

The tool lets you automate the addition, removal or alteration of the branch protection rules for 1 or more branches & repositories in one go. This helps users to bulk update the branch rules which saves lot of time when you have hundreds of branches and repositories in your organization.

Supported branch protection rules

The tool currently supports adding or modifying the below branch protection rules-

  • Require pull request reviews before merging
    • Dismiss stale pull request approvals when new commits are pushed
    • Require review from Code Owners
    • Restrict who can dismiss pull request reviews
  • Require status checks to pass before merging
    • Require branches to be up to date before merging
  • Require signed commits
  • Include administrators
  • Restrict who can push to matching branches
  • Add or update CODEOWNERS

Prerequisites

You can run the tool as Docker Container or cli using Python. Refer to the below sections in both cases.

  • A GitHub organization with permissions to update the branch protection rules
  • Git installed on your machine.Click here to get the latest version of Git.

Run as a Docker Container ๐Ÿณ

  • Docker installed on your machine

Run using Python ๐Ÿ

  • Python 3.8 or above installed on your machine

  • Install the latest version of pip

    python -m pip install --upgrade pip

  • Install the Python library stdiomask

    pip install stdiomask

  • Install the Python library PyGithub

    pip install pygithub

Note โš ๏ธ Run the above commands as a root user (linux) or as an administrator mode in command prompt (windows).

Usage Instructions ๐Ÿ“

To learn how to setup and use the tool click here.

Current limitations โŒ โŒ

  • The tool does not support for Personal user accounts
  • Allow force pushes, Allow deletions and Require linear history rules are not supported

You can try the web app from here.

License

The scripts and documentation in this project are released under the MIT License

automate-branch-rules-cli's People

Contributors

grenston avatar sriplayground avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.