メインコンテンツへスキップ

はじめに

GitHub Enterpriseは、 GitHub.com のオンプレミスバージョンです。大企業のソフトウェア開発チームはコーディングを共同で行い、楽しむことができます。 GitHub Enterpriseには GitHub. com と同様の優れた機能セットが用意されていますが、組織のローカルネットワーク上で動作するようにパッケージ化されています。すべてのリポジトリデータは各自が管理するマシンに保存され、アクセスは組織の認証システム(LDAP、CAS)に統合されています。GitHub Enterpriseはリポジトリとプロジェクト情報を完全にコントロールする必要がある場合に使用します。 GitHub Enterprise アカウントには、Data Centerから接続します。このトピックでは、 GitHub Enterprise コネクターユーザーインターフェースに固有のフィールドとメニューについて説明します。DataSetの追加や更新スケジュールの設定、DataSet情報の編集に関する一般的な情報は、「 コネクターを使用してDataSetを追加する 」を参照してください。

必要条件

GitHub Enterpriseアカウントに接続してDataSetを作成するには、以下が必要です。
  • GitHub Enterprise ユーザー名
  • 適切にスコープされた個人用アクセストークン
  • GitHub Enterpriseインスタンスに対する ホスト名

GitHub Enterprise アカウントに接続する

このセクションでは、GitHub Enterpriseコネクターページの[認証情報]および[詳細]ペインのオプションについて説明します。このページのほかのペインの項目である [スケジュール設定][DataSetに名前を付け、説明を入力] に関しては、ほとんどのタイプのコネクターで共通しています。詳細については、「 コネクターを使用してDataSetを追加する 」を参照してください。

[認証情報]ペイン

このペインには、 GitHub Enterprise アカウントに接続するための認証情報の入力フィールドがあります。以下の表は、各フィールドに必要な内容を説明しています。

フィールド

説明

Send PAT in authorization header as APIコールの認証ヘッダーでPATを送信する方法を選択します。

GitHubでは、 トークン ベースの認証ヘッダーの使用が推奨されています。
Hostname http://」 や「 https://」 を含めずにホスト名を入力します。

例:URLが https://xx.yy.zz.com の場合は、 xx.yy.zz.com
のみを入力します。
Username

GitHub Enterpriseインスタンスへの接続にDomoで使用するアカウントのユーザー名を入力します。

Personal Access Token (PAT)

個人用アクセストークンを入力します。

個人用アクセストークンを作成 するときは、実行するレポートごとに 適切なスコープ(権限) を指定する必要があります。

有効な GitHub Enterprise 認証情報を一度入力しておくと、随時同じアカウントを使用して新しい GitHub Enterprise DataSetを作成できます。コネクターアカウントは、Data Centerの [アカウント] タブで管理できます。このタブの詳細については、「 コネクター/アダプターアカウントを管理する 」を参照してください。
注記:Domoで接続する際、既に GitHub Enterprise にログインしている場合は、[アカウントを追加] をクリックすると自動的に認証されます。ログインしているアカウントとは異なるアカウントに接続する場合は、まず GitHub Enterprise からログアウトする必要があります。

[詳細]ペイン

このペインには、メインとなる [Report] メニューのほか、選択したレポートタイプに応じて表示/非表示になる様々なメニューが含まれています。

メニュー

説明

Report

実行する GitHub Enterprise レポートを選択します。実行するレポートに必要なスコープを個人用アクセストークン(PAT)に許可する必要があります。

すべてのレポートを実行できるようにするには、以下のリンクを使って、必要な すべての スコープ を指定してアクセストークンを 作成 してください。

https:// .com /settings/tokens/new?description=Domo%20GitHub%20Enterprise%20Connector&scopes=user,read:org,gist,repo,admin:org,admin:org_hook,admin:repo_hook,admin:public_key

以下のレポートが利用できます。

レポート名

レポートの説明

必要なPATスコープ

All Notifications

現在のユーザーに対するすべての通知のリストを、リポジトリごとにグループ化して返します。

user

All Organizations

すべての組織のリストを返します。

read:org

All Organizations (Advanced)

サイト管理者ダッシュボードAPIを使用しているすべての組織のリストを返します。

read:org

All Private Feeds

すべてのプライベートフィードのリストを返します。

スコープなし

All Public Events

パブリックイベントのリストを返します。

スコープなし

All Public Gists

すべてのパブリックGistのリストを返します。

gist

All Public Repositories

すべてのパブリックリポジトリのリストを返します。

repo

All Repo Comments

すべてのリポジトリに対するコメントのリストを返します。

repo

All Repo Commits

すべてのリポジトリに対するコミットのリストを返します。

repo

All Repo Issues

すべてのリポジトリに対する問題のリストを返します。

repo

All Repo Pull Request

すべてのリポジトリのプルリクエストのリストを返します。

repo

All Repo Pull Request Comments

すべてのリポジトリのプルリクエストコメントのリストを返します。

repo

All Repo Pull Request Reviews

すべてのリポジトリのプルリクエストレビューのリストを返します。

repo

All Repositories (Advanced)

サイト管理者ダッシュボードAPIを使用しているすべてのリポジトリデータのリストを返します。

repo

All Users

GitHubに新規登録した順で、すべてのユーザーのリストを返します。

user

All Users (Advanced)

すべてのユーザーとその状態のリストを返します。このレポートはサイト管理者ダッシュボードAPIを使用します。

user

Authenticated User

認証時の公開情報と非公開情報を一覧表示します。

user

Authenticated User Emails

ユーザーのメールアドレスを一覧表示します。

user

Authenticated User Issues

認証されたユーザーに割り当てられたリポジトリ全体のすべての問題を一覧表示します。

user

Authenticated User Organizations

組織のリストを返します。

user

Authenticated User Repositories

指定したユーザーのリポジトリを一覧表示します。

user、repo

Authenticated User Starred Gists

認証されたユーザーのスター付きGistのリストを返します。

user、gist

Company Productivity (All Repository Issues)

すべてのリポジトリの問題に関するメトリクスデータを返します。

repo

Company Productivity (All Repository Pull Requests)

すべてのリポジトリのプルリクエストに関するメトリクスデータを返します。

repo

Gists Comments

Gistのコメントのリストを返します。

gist

Organization Details

組織に関する詳細を返します。

admin:org

Organization Issues - User

認証されたユーザーについて、特定の組織のすべての問題を一覧表示します。

admin:org

Organization Members List

組織メンバーシップのリストを返します。

admin:org

Organization Teams List

組織のチームを一覧表示します。

admin:org

Organization Webhooks List

組織のすべてのWebhookを一覧表示します。

admin:org_hook

Repository Events

リポジトリに固有のイベントのリストを返します。

repo

Repository Notifications

現在のユーザーに対するすべての通知のリストを返します。

repo

Repository Stargazers

リポジトリのスターゲイザーのリストを返します。

repo

Repository Subscribers

リポジトリのサブスクライバーのリストを返します。

repo

Repository Issues

リポジトリの問題のリストを返します。

repo

Repository Assignees

リポジトリの担当者のリストを返します。

repo

Repository Issue Comments

リポジトリの問題に関するコメントのリストを返します。

repo

Repository Issue Events

リポジトリのイベントのリストを返します。

repo

Repository Labels

このリポジトリに対するすべてのラベルのリストを返します。

repo

Repository Milestones

リポジトリのマイルストーンのリストを返します。

repo

Repository Pulls

リポジトリのプルリクエストのリストを返します。

repo

Repository Contributors

リポジトリの貢献者のリストを返します。

repo

Repository Teams

リポジトリのチームのリストを返します。

repo

Repository Languages

指定されたリポジトリの言語のリストを返します。言語の右側の値は、その言語で記述されたコードのバイト数です。

repo

Repository Tags

リポジトリのタグのリストを返します。

repo

Repository Branches

リポジトリのブランチのリストを返します。

repo

Repository Collaborators

リポジトリの共同ユーザーのリストを返します。

repo

Repository Comments

リポジトリのコメントのリストを返します。

repo

Repository Commits

リポジトリのコミットのリストを返します。

repo

Repository Contents

READMEに記載されているリポジトリのコンテンツを返します。

repo

Repository DeployKeys

このリポジトリのデプロイキーのリストを返します。

repo

Repository Deployments

このリポジトリのデプロイメントのリストを返します。

repo

Repository Downloads

このリポジトリのダウンロードのリストを返します。

repo

Repository Forks

このリポジトリのフォークのリストを返します。

repo

Repository Merges

このリポジトリの結合のリストを返します。

repo

Repository Pages

このリポジトリのページのリストを返します。

repo

Repository Releases

このリポジトリのリリースのリストを返します。

repo

Repository Releases Latest

このリポジトリの最新リリースのリストを返します。

repo

Repository Statistics Code Frequency

リポジトリにプッシュされた追加と削除の数を週単位で集計して返します。

repo

Repository Statistics Contributors

追加、削除、コミットの回数とともに、リポジトリへの貢献者のリストを返します。

repo

Repository Statistics Commit Activity

コミットアクティビティデータの最後の年を返します。

repo

Repository Statistics Participation

リポジトリの所有者とほかのすべての人の毎週のコミット数を返します。

repo

Repository Webhooks

リポジトリのWebhookのリストを返します。

admin:repo_hook

Search Code

特定のフレーズが検出されたコード内の場所を返します。

スコープなし

User Followers

ユーザーのフォロワーのリストを返します。

user

User Following

ほかのユーザーがフォローしているユーザーのリストを返します。

user

User Keys

ユーザーのキーのリストを返します。

admin:public_key

User Organizations

ユーザー組織のリストを返します。

user

User Repos

ユーザーリポジトリのリストを返します。

user

利用可能な権限(スコープ):

スコープとは、コネクターがレポートを作成できるようにするために 個人用アクセストークン に許可する必要がある権限セットです。 以下は利用可能なスコープのリストです。

名前

説明

Repo

コード、コミットのステータス、リポジトリ招待、共同ユーザー、デプロイメントステータス、リポジトリWebhookに対する読み取りアクセスと書き込みアクセスなど、パブリック、内部、プライベートリポジトリへのフルアクセスを許可します。

注記: repo スコープでは、リポジトリ関連のリソースのほかに、プロジェクト、招待、チームメンバーシップ、Webhookなど、組織所有のリソースを管理するためのアクセスも許可されます。また、このスコープにより、ユーザーが所有するプロジェクトも管理できるようになります。

repo:status

パブリック、プライベート、および内部リポジトリのコミットステータスに対する読み取り/書き込みアクセスを許可します。このスコープが必要となるのは、コードへのアクセスを許可 せずに 、ほかのユーザーやサービスにプライベートリポジトリのコミットステータスへのアクセスを許可する場合のみです。

repo_deployment

パブリックおよびプライベートリポジトリの デプロイメントステータス へのアクセスを許可します。このスコープが必要となるのは、コードへのアクセスを許可 せずに 、ほかのユーザーやサービスにデプロイメントステータスへのアクセスを許可する場合のみです。

public_repo

パブリックリポジトリへのアクセスを制限します。パブリックリポジトリや組織のコード、コミットステータス、リポジトリプロジェクト、共同ユーザー、デプロイメントステータスに対する読み取り/書き込みアクセスが含まれます。また、パブリックリポジトリのスター付けにも必要です。

repo:invite

リポジトリでのコラボレーションへの招待を承諾/拒否する機能を許可します。このスコープが必要となるのは、コードへのアクセスを許可 せずに 、ほかのユーザーやサービスに招待へのアクセスを許可する場合のみです。

admin:repo_hook

パブリック、プライベート、または内部リポジトリのリポジトリフックへの読み取り、書き込み、ping、削除のアクセスを許可します。 repo public_rep のスコープでは、リポジトリフックを含むリポジトリへのフルアクセスが許可されます。リポジトリフックのみにアクセスを制限するには、 admin:repo_hook スコープを使用します。

read:repo_hook パブリック、プライベート、または内部リポジトリのフックへの読み取りとpingのアクセスを許可します。
admin:org

組織とそのチーム、プロジェクト、メンバーシップを完全に管理します。

read:org 組織メンバーシップ、組織プロジェクト、およびチームメンバーシップに対する読み取り専用アクセス。
admin:public_key

パブリックキーを完全に管理します。

read:public_key パブリックキーの詳細を一覧で表示します。
admin:org_hook

組織フックに対する読み取り、書き込み、ping、削除のアクセスを許可します。 注記: OAuthトークンがこれらの操作を実行できるのは、OAuth Appで作成された組織フックに対してのみです。個人用アクセストークンがこれらの操作を実行できるのは、ユーザーが作成した組織フックに対してのみです。

gist

Gistへの書き込みアクセスを許可します。

notifications

以下を許可します。
ユーザーの通知に対する読み取りアクセス
スレッドに対する既読としてマークのアクセス
リポジトリに対するウォッチおよびウォッチ解除のアクセス
スレッドのサブスクリプションに対する読み取り、書き込み、削除のアクセス。

user

プロフィール情報への読み取り/書き込みアクセスのみを許可します。このスコープにはuser:emailとuser:followが含まれることに注意してください。

read:user ユーザーのプロフィールデータに対する読み取りアクセスを許可します。
user:email ユーザーのメールアドレスに対する読み取りアクセスを許可します。

その他のペイン

スケジュール設定、再試行、更新オプションなど、その他のコネクターインターフェースのセクションの詳細については、「 コネクターを使用してDataSetを追加する 」を参照してください。

よくある質問

起動するには、ネットワークの許可リストにコネクターを追加する必要があります。また、ITチームと協力して ネットワークの許可リストにDomoのIPを追加する ことで、コネクターがGitHub Enterpriseインスタンスと通信できるように Domoのコネクターを許可する必要があります
このコネクターは GitHub EnterpriseAPI( https://{あなたのドメイン.com}/api/v3/)のバージョン3を使用します。
レポート名 エンドポイントURL(1つまたは複数)
All Notifications /notifications
All Organizations /organizations
All Organizations (Advanced) /stafftools/reports/all_organizations.csv
All Private Feeds /feeds
All Public Events /events
All Public Gists /gists/public
All Public Repositories /repositories

All Repo Comments

/repos/%s/%s/comments

All Repo Commits

/repos/%s/%s/commits

All Repo Issues

/repos/%s/%s/issues

All Repo Pull Request

repos/%s/%s/pulls

All Repo Pull Request Comments

repos/%s/%s/pulls/comments

All Repo Pull Request Reviews

null

All Repositories (Advanced)

/stafftools/reports/all_repositories.csv
All Users /users

All Users (Advanced)

/stafftools/reports/all_users.csv
Authenticated User /user
Authenticated User Emails /user/emails
Authenticated User Issues /user/issues
Authenticated User Organizations /user/orgs
Authenticated User Repositories /user/repos
Authenticated User Starred Gists /gists/starred

Company Productivity (All Repository Issues)

/repos/%s/%s/issues

Company Productivity (All Repository Pull Requests)

/repos/%s/%s/issues
Gists Comments /gists/{Gist ID}/comments
Organization Details /orgs/
Organization Issues - User /orgs//issues
Organization Members List /orgs//members
Organization Teams List /orgs//teams
Organization Webhooks List /orgs//hooks
Repository Events /repos///events
Repository Notifications /repos///notifications
Repository Stargazers /repos///stargazers
Repository Subscribers /repos///subscribers
Repository Issues /repos///issues
Repository Assignees /repos///assignees
Repository Issues Comments /repos///issues//comments
Repositories Issue Events /repos///issues/events
Repository Labels /repos///labels
Repository Milestones /repos///milestones
Repository Pulls /repos///pulls
Repository Contributors /repos///contributors
Repository Teams /repos///teams
Repository Languages /repos///languages
Repository Tags /repos///tags
Repository Branches /repos///branches
Repository Collaborators /repos///collaborators
Repository Comments /repos///comments
Repository Commits /repos///commits
Repository Contents /repos///readme
Repository DeployKeys /repos///keys
Repository Deployments /repos///deployments
Repository Downloads /repos///downloads
Repository Forks /repos///forks
Repository Merges /repos///merges
Repository Pages /repos///pages
Repository Releases /repos///releases
Repository Releases Latest /repos/%s/%s/releases/latest
Repository Statistics Code Frequency /repos/%s/%s/stats/code_frequency
Repository Statistics Contributors /repos///stats/contributors
Repository Statistics Commit Activity /repos///stats/commit_activity
Repository Statistics Participation /repos///stats/participation
Repository Webhooks /repos///hooks

Search Code

/search/code
User Followers /users//followers
User Following /users//following
User Keys /users//keys
User Organizations /users//orgs
User Repos /users//repos
GitHub Enterpriseアカウントのホスト名、ユーザー名、および個人用アクセストークンが必要です。
必要に応じて何回でも更新できます。
ありません。

トラブルシューティング

  • 認証が有効であることを確認してください。
  • 設定を見直し、すべての必須項目が選択されていることを確認してください。
  • コネクターの履歴にエラーメッセージが記録されていないか確認してください。
  • まれに、リクエストした情報が多すぎた結果、API制限またはタイムアウトに達する場合があります。記録されている場合は、コネクターの履歴でエラーメッセージと実行時間を確認することができます。また、取得するアカウント数やレポートのメトリクス数を減らしたり、取得するタイムフレームを短縮したりすることができます。