GitHubをデータパイプラインソースとして設定 ​

GitHub REST APIおよびGraphQL APIからリポジトリ、Issue、プルリクエスト、コミット、関連するDevelopmentレコードを抽出し、送信先に同期するために、GitHubをデータパイプラインソースとして設定します。お使いの送信先に同期します。

このガイドでは、機能と前提条件の確認、GitHubのデータパイプラインソースとしての接続、パイプラインの設定、サポート対象オブジェクト、同期モード、スキーマ処理、機密データ処理、制限事項について説明します。

サポートされている機能 ​

GitHubをパイプラインソースとして使用する場合、次の機能がサポートされます。

• クラウドおよびセルフホスト接続：https経由でGitHub.comおよびGitHub Enterprise Cloudに接続します。 セルフホスト型のGitHub Enterprise Serverインスタンスに接続するには、コネクションをオンプレミスエージェント経由でルーティングします。
• 組織スコープの同期：パイプラインを設定するときに、1つ以上のGitHub組織を選択します。 Workatoは、コネクションがアクセスできるそれらの組織内のすべてのリポジトリを同期します。
• オブジェクトレベルの選択：同期するオブジェクトを、送信先の個別のテーブルとして選択します。 完全なリストについては、サポートされているオブジェクトを参照してください。
• 完全同期と増分同期：Issue、IssueComment、Commit、ReviewCommentオブジェクトは、GitHubのsinceパラメーターを使用した増分同期をサポートします。 その他のすべてのオブジェクトは、各実行時に完全同期されます。 詳細については、同期モードを参照してください。
• 削除追跡：Workatoは各完全同期を前回の実行と比較し、GitHubに存在しなくなったレコードを送信先で削除済みとしてマークします。
• スキーマドリフトの検出と処理: 新しいフィールドを自動同期でスキーマの変更を自動的に検出して適用するか、新しいフィールドをブロックでスキーマを固定します。
• フィールドレベルのデータ保護: 機密フィールドをそのままレプリケートするか、宛先に到達する前にハッシュ化します。
• 構成可能な同期頻度: 時間ベースの間隔またはcron式を使用して同期をスケジュールします。 サポートされる最小間隔は15分です。

前提条件 ​

GitHubをデータパイプラインソースとして接続するには、次が必要です。

• 同期する組織およびリポジトリへのアクセス権を持つGitHub.com、GitHub Enterprise Cloud、またはGitHub Enterprise Serverアカウント
• パイプラインのスコープ設定に使用する1つ以上のGitHub組織ログイン
• セルフホスト型のGitHub Enterprise Serverインスタンスに接続する場合は、オンプレミスエージェント
• 選択した認証方法の認証情報:
  • OAuth App：Workatoの登録済みOAuth Appを承認する権限を持つGitHubアカウント
  • Personal access token：GitHubアカウントから生成されたclassicまたはfine-grained personal access token

必要な権限 ​

選択したオブジェクトを同期するために必要な読み取りレベルの権限のみを付与します。

サポートされるコネクションタイプ ​

GitHubデータパイプラインは、次の2つの認証方法をサポートします。

• OAuth App：標準のブラウザーリダイレクトフローを通じて、Workatoの登録済みGitHub OAuth Appを承認します。 OAuthトークンは長期間有効であり、承認を取り消すかOAuth Appが削除されない限り期限切れになりません。
• Personal access token：GitHubアカウントから生成されたclassicまたはfine-grained personal access tokenを指定します。 Workatoでは、対話型のOAuthフローが実用的でないサーバー間設定にこの方法を推奨しています。

GitHubに接続 ​

GitHubをデータパイプラインソースとして接続するには、次の手順を完了します。

パイプラインの設定 ​

GitHubをデータパイプラインソースとして設定するには、次の手順を完了します。

[minute] [hour] [day of month] [month] [day of week]

0 8 * * *

サポートされるオブジェクト ​

GitHubデータパイプラインは、GitHub REST APIからデータを同期し、プルリクエストレビューとリリースについてはGraphQL APIからデータを同期します。 次の表は、サポートされているオブジェクトをカテゴリ別に示しています。 各オブジェクトは、送信先で個別のテーブルとして同期されます。

組織、リポジトリ、アクセス ​

課題とプルリクエスト ​

GitHubは、同じエンドポイントから課題とプルリクエストを返します。 Workatoは、各レコードのpull_requestフィールドを確認して両者を区別するため、Issueオブジェクトではプルリクエストの形をした行が除外されます。

コミットとリポジトリコンテンツ ​

CommitFileとBranchCommitRelationは、オプトインの高ボリュームオブジェクトです。 いずれかのオブジェクトを追加する前に、高ボリュームオブジェクトには慎重な同期計画が必要を参照してください。

CI/CDとリリース ​

エンゲージメントとセキュリティ ​

SecurityAlertを使用するには、リポジトリでDependabotが有効化され、コネクションに適切な権限が付与されている必要があります。 詳細については、Dependabotアラートにはリポジトリと権限の設定が必要を参照してください。

同期モード ​

GitHubデータパイプラインは、完全同期と増分同期をサポートします。 各オブジェクトの同期モードを確認するには、サポート対象オブジェクトを参照してください。

フル同期 ​

完全同期では、選択したオブジェクトについてGitHubから利用可能なすべてのレコードを各実行で読み取り、送信先テーブルを上書きします。

増分同期 ​

増分同期では、GitHubのsinceパラメーターをカーソルとして使用し、前回の正常な実行以降に作成または更新されたとGitHubが報告するレコードのみを抽出します。 Issue、IssueComment、Commit、ReviewCommentのみが増分同期をサポートします。 IssueLabelやWorkflowRunJobなど、親オブジェクトと一緒に同期されるオブジェクトを含むその他のすべてのオブジェクトは、常に完全同期されます。

削除追跡 ​

Workatoは各完全同期を前回の実行と比較し、GitHubに存在しなくなったレコードを送信先で削除済みとしてマークします。 これはすべての完全同期オブジェクトに適用されます。

GitHubのsinceパラメーターは削除を報告しないため、Issue、IssueComment、Commit、ReviewCommentは増分同期中に削除を追跡しません。 これらのオブジェクトについては、完全同期を実行するまで、GitHubで削除されたレコードは送信先に残ります。 詳細については、増分オブジェクトは削除を追跡しませんを参照してください。

スキーマとデータ型の処理 ​

GitHubからデータを同期する場合、スキーマとデータ型について次の考慮事項が適用されます。

ネストされたフィールド ​

GitHubのレスポンスには、プルリクエストのbaseおよびheadブランチ参照や、コミットの未加工のcommitメタデータなど、ネストされたオブジェクトと配列が含まれます。 Workatoはこれらを個別の列にフラット化するのではなく、JSON文字列列として保存します。

カスタムプロパティは同期されません ​

GitHub Enterprise CloudとGitHub Enterprise Serverは、リポジトリレベルのカスタムプロパティをサポートしています。 Workatoは、このリリースではカスタムプロパティを同期しません。 各オブジェクトに一覧表示されている標準フィールドのみが利用可能です。

機密データの処理 ​

GitHubオブジェクトには、個人を特定できる情報（PII）が含まれる場合があります。 次のオブジェクトには、一般的に機密フィールドが含まれます:

Issue、IssueComment、PullRequest、ReviewCommentのbodyフィールドは自由記述テキストです。 コントリビューターは、課題の説明、プルリクエストの説明、コメントにアカウント情報、認証情報、その他の顧客データを貼り付ける可能性があるため、これらのフィールドは最もリスクが高くなります。

パイプライン設定中にフィールドレベルのデータ保護でHashオプションを使用し、PIIが宛先に到達する前に保護します。 詳細については、パイプラインを構成手順を参照してください。

制限事項 ​

GitHubをデータパイプラインソースとして使用する場合、次の制限事項が適用されます。

増分オブジェクトは削除を追跡しません ​

Issue、IssueComment、Commit、ReviewCommentは、GitHubのsinceパラメーターを使用して増分同期されますが、このパラメーターは削除を報告しません。 これらのオブジェクトについては、完全同期を実行するまで、GitHubで削除されたレコードは送信先に残ります。 詳細については、削除追跡を参照してください。

特定のリポジトリに絞り込むことはできません ​

パイプラインは、選択した組織内でコネクションがアクセスできるすべてのリポジトリを同期します。 個々のリポジトリを含めたり除外したりすることはできません。 組織に属していない個人リポジトリは同期されません。

高ボリュームオブジェクトには慎重な同期計画が必要 ​

CommitFileオブジェクトとBranchCommitRelationオブジェクトは、大量のレコードを生成する可能性があります。 CommitFileでは、ファイルレベルの差分データを取得するためにコミットごとに1回のAPI呼び出しが必要であり、一括エンドポイントはありません。

Dependabotアラートにはリポジトリと権限の設定が必要 ​

SecurityAlertオブジェクトは、Dependabotセキュリティアラートを同期します。 Dependabotが無効化されているリポジトリでは行を返さず、コネクションに必要な権限がない場合はそのオブジェクトの同期が失敗します。 付与する必要があるスコープについては、必要な権限を参照してください。

GitHub Enterprise Serverのバージョン差異 ​

GitHub Enterprise Serverは、GitHub.comより複数のバージョン遅れている場合があります。 GitHub.comで利用可能な一部のオブジェクトとフィールドは、アップグレードするまでGitHub Enterprise Serverインスタンスで利用できない場合があります。

最小同期頻度 ​

サポートされる最小同期間隔は15分です。 これより高い頻度で同期をトリガーすることはできません。