Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.43 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.43 KB
Raw

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.