Giter Club home page Giter Club logo

gh-branch-protection-report's Introduction

GitHub Branch Protection Report

This GitHub CLI extension fetches the repositories of a GitHub organization, gets the branch protection rules for each repository, gets the admins for each repository, and writes the data to a CSV file.

Installation

  1. Clone this repository:
git clone https://github.com/homeles/gh-branch-protection-report.git
  1. Navigate to the project directory:
cd gh-branch-protection-report
  1. Install the dependencies:
pip3 install -r requirements.txt
  1. Make the script executable:
gh extension install .

Usage

  1. Set your GitHub token and the name of the GitHub organization as environment variables in the .env file:
GITHUB_TOKEN=yourgithubtoken
ORG_NAME=yourorgname
  1. Run the script:
gh branch-protection-report --token yourgithubtoken --org yourorgname

The script will create a CSV file with the branch protection rules and admins for each repository in the specified GitHub organization. The CSV file includes the repository name, default branch, whether branch protection is enabled, the required review count, whether code owner reviews are required, whether restrictions are enabled, whether admin enforcement is enabled, whether deletions are allowed, whether linear history is required, and the admins of the repository.

Replace your githubtoken and yourorgname with your GitHub token and the name of the GitHub organization, respectively.

gh-branch-protection-report's People

Contributors

homeles avatar

Watchers

 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.