[GitHub]組織内プロジェクトよりブランチをリスト化する

はじめに

誰がいつ作ったブランチなのかをリスト化したくて調べました。
私と同じ悩みを抱えている方に届けばと思います。

環境

GitHubのapiをPythonで実行します。
※Pythonが実行できる環境であれば問題ないです

私は以下の環境で実行しました。

OS：Windows
エディタ：VSCode

事前準備

GitHubのトークンを取得

以下の手順で取得できます。

1. GitHubのPersonal Access Tokenの設定ページにアクセス
2. 「Generate new token」 または 「Fine-grained tokens」 を選択
3. 必要なスコープ (repo または public_repo) にチェックを入れる
4. トークンを生成する

Pythonコード

以下のPythonのコード「設定」部分を編集することで実行できます。

import requests
from urllib.parse import quote

# 設定（ここだけ編集すれば動く）
GITHUB_TOKEN = "{取得したトークン}"
ORG_NAME = "{組織の名前}"

# ヘッダー
headers = {
    "Authorization": f"token {GITHUB_TOKEN}"
}

# 組織のリポジトリ一覧を取得
repo_url = f"https://api.github.com/orgs/{ORG_NAME}/repos"
repos = requests.get(repo_url, headers=headers).json()

# ユーザーが生成したブランチを収集
user_branches = []

for repo in repos:
    repo_name = repo["name"]
    # 念のためリポジトリ名をURLエンコードしておく
    encoded_repo_name = quote(repo_name, safe="")
    branches_url = f"https://api.github.com/repos/{ORG_NAME}/{encoded_repo_name}/branches"
    branches = requests.get(branches_url, headers=headers).json()

    for branch in branches:
        branch_name = branch["name"]
        # 念のためブランチ名をURLエンコードしておく
        encoded_branch_name = quote(branch_name, safe="")
        commits_url = f"https://api.github.com/repos/{ORG_NAME}/{repo_name}/commits?sha={encoded_branch_name}"
        commits = requests.get(commits_url, headers=headers).json()

        if commits:
            user_branches.append({
                "repo": repo_name,
                "branch": branch_name,
                "author": commits[0]["commit"]["author"]["name"],
                "date": commits[0]["commit"]["author"]["date"]
                })

# 結果を表示
for branch in user_branches:
    print(f"Repo: {branch['repo']}, Branch: {branch['branch']}, Author: {branch['author']}, Date: {branch['date']}")