零弐壱蜂

[GitHub] 対象リポジトリのラベル情報を取得する方法

2 min read
GitHub API
hiroweb developer

背景

GitHub リポジトリにあるラベル情報（id）を取得したい。

方法

  1. ブラウザ上から確認する方法
  2. CLI から確認する方法

1. ブラウザ上から確認する方法

  1. ラベルの一覧ページに遷移

    https://github.com/{owner}/{repo}/labels

  2. 確認したいラベルの Edit ボタンをクリック

  3. DevTools のネットワークタブで確認する
    https://github.com/{owner}/{repo}/labels/preview/ に対するリクエストに id 情報が載っている

    color: f29513
description: Something isn't working
id: 208045946

2. CLI から確認する方法

GitHub REST APIを叩くので全てのラベル情報を取得できる。

GitHub CLI を入れる

GitHub CLIを使うと GitHub リポジトリ内の情報が簡単に取得できる。

# インストール
brew install gh

プライベートリポジトリであっても gh auth login をしておけば情報取得が可能になるため、GitHub CLI を使うと良い。

GitHub CLI でラベル情報を取得する

ラベル情報はラベル APIから取得できる。

# GitHub CLI api
# https://cli.github.com/manual/gh_api

gh api \
  -H "Accept: application/vnd.github+json" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  /repos/OWNER/REPO/labels

上記を実行すると下記のようなラベル情報が取得できる。

[
  {
    "id": 208045946,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug",
    "name": "bug",
    "description": "Something isn't working",
    "color": "f29513",
    "default": true
  },
  {
    "id": 208045947,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDc=",
    "url": "https://api.github.com/repos/octocat/Hello-World/labels/enhancement",
    "name": "enhancement",
    "description": "New feature or request",
    "color": "a2eeef",
    "default": false
  }
]