はじめに
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) | 個人用アクセストークンを入力します。 個人用アクセストークンを作成 するときは、実行するレポートごとに 適切なスコープ(権限) を指定する必要があります。 |
[詳細]ペイン
このペインには、メインとなる [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 以下のレポートが利用できます。
|
利用可能な権限(スコープ):
スコープとは、コネクターがレポートを作成できるようにするために 個人用アクセストークン に許可する必要がある権限セットです。 以下は利用可能なスコープのリストです。名前 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|
Repo | コード、コミットのステータス、リポジトリ招待、共同ユーザー、デプロイメントステータス、リポジトリWebhookに対する読み取りアクセスと書き込みアクセスなど、パブリック、内部、プライベートリポジトリへのフルアクセスを許可します。 注記: repo スコープでは、リポジトリ関連のリソースのほかに、プロジェクト、招待、チームメンバーシップ、Webhookなど、組織所有のリソースを管理するためのアクセスも許可されます。また、このスコープにより、ユーザーが所有するプロジェクトも管理できるようになります。
| ||||||||
admin:repo_hook | パブリック、プライベート、または内部リポジトリのリポジトリフックへの読み取り、書き込み、ping、削除のアクセスを許可します。
| ||||||||
| admin:org | 組織とそのチーム、プロジェクト、メンバーシップを完全に管理します。
| ||||||||
| admin:public_key | パブリックキーを完全に管理します。
| ||||||||
| admin:org_hook | 組織フックに対する読み取り、書き込み、ping、削除のアクセスを許可します。 注記: OAuthトークンがこれらの操作を実行できるのは、OAuth Appで作成された組織フックに対してのみです。個人用アクセストークンがこれらの操作を実行できるのは、ユーザーが作成した組織フックに対してのみです。 | ||||||||
| gist | Gistへの書き込みアクセスを許可します。 | ||||||||
| notifications | 以下を許可します。 | ||||||||
| user | プロフィール情報への読み取り/書き込みアクセスのみを許可します。このスコープにはuser:emailとuser:followが含まれることに注意してください。
|
その他のペイン
スケジュール設定、再試行、更新オプションなど、その他のコネクターインターフェースのセクションの詳細については、「 コネクターを使用してDataSetを追加する 」を参照してください。よくある質問
このコネクターはホワイトリスト登録(許可リスト登録)が必要ですか?
このコネクターはホワイトリスト登録(許可リスト登録)が必要ですか?
このコネクターではどのバージョンの GitHub Enterprise APIを使用しますか?
このコネクターではどのバージョンの GitHub Enterprise APIを使用しますか?
各レポートコールによってこのコネクターで呼び出されるのはどのエンドポイントですか?
各レポートコールによってこのコネクターで呼び出されるのはどのエンドポイントですか?
| レポート名 | エンドポイント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 | |
このコネクターを作成するにはどのような認証情報が必要ですか?
このコネクターを作成するにはどのような認証情報が必要ですか?
データはどれくらいの頻度で更新可能ですか?
データはどれくらいの頻度で更新可能ですか?
注意すべきAPI制限はありますか?
注意すべきAPI制限はありますか?
トラブルシューティング
- 認証が有効であることを確認してください。
- 設定を見直し、すべての必須項目が選択されていることを確認してください。
- コネクターの履歴にエラーメッセージが記録されていないか確認してください。
- まれに、リクエストした情報が多すぎた結果、API制限またはタイムアウトに達する場合があります。記録されている場合は、コネクターの履歴でエラーメッセージと実行時間を確認することができます。また、取得するアカウント数やレポートのメトリクス数を減らしたり、取得するタイムフレームを短縮したりすることができます。