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

GitHubからコンテンツを同期する

GitHubリポジトリからMarkdownファイルをFinに同期し、FinとCopilotが利用できるようにします。

GitHubコンテンツ同期では、GitHubリポジトリからMarkdown(.md)ファイルをFinに同期し、FinとCopilotが利用できるようにします。


はじめに

  1. Train > Contentに移動し、See allをクリックしてからFrom GitHubを選択します。

  2. 接続したいGitHubアカウントに対してFin GitHub同期アプリをインストールします。組織アカウントの場合は、組織管理者の承認が必要な場合があります。

  3. アプリがすべてのリポジトリにアクセスできるか、選択したリポジトリのみアクセスできるかを選択します。

  4. GitHubの設定が完了するとポップアップウィンドウが閉じます。同期したいMarkdownファイルのあるリポジトリと必要に応じてフォルダーを選択します。

  5. (オプション)CLAUDE.mdファイルを作成または更新して、Claude Codeが同期されたコンテンツの作成・更新方法やFrontmatterスキーマの使用方法を指示することができます。

  6. Clone and connectをクリックします。

注意:後で別のリポジトリへのアクセスを許可するには、Manage GitHub repository access on GitHubをクリックします。同じポップアップウィンドウが開き、許可リストにリポジトリを追加できます。


権限

Fin GitHub同期アプリには以下のGitHub権限が必要です:

  • メタデータ(読み取り専用):すべてのGitHubアプリが持つデフォルトのスコープです。

  • チェック(読み書き):以下のPR checksで説明するFrontmatterスキーマのチェックを実行します。

  • コード(読み書き):CLAUDE.mdファイルを作成または更新します。ファイルの作成は任意ですが、この権限は必要です。

  • プルリクエスト(読み書き):CLAUDE.mdファイルを作成し、Finへの同期やPRチェックを実行するためのWebhookを受け取ります。

  • Workflows(読み書き):リポジトリにGitHub Actionsのワークフローを追加し、Finの提案プルリクエストを自動承認・マージできるようにします(オプションの自動マージ設定)。


同期の仕組み

リポジトリを初めて接続すると、Finはそのリポジトリまたは選択したフォルダー内のすべてのMarkdownファイルを同期します。その後、これらのMarkdownファイルに変更がマージされると、Finが自動的に編集を適用します。


(オプション)Frontmatterスキーマ

Frontmatterは必須ではありません。Markdownファイルでまだ使用していない場合は、このセクションをスキップできます。Frontmatterは各ファイルがFinに同期される方法の追加プロパティを設定できます。Markdownファイルの先頭に次のように追加します:

---
title: How to request a refund
description: Steps to get a refund on your order
audience: everyone
published: true
fin: enabled
copilot: enabled
sales_agent: disabled
---

Article body goes here…

対応するキーと値:

  • title(任意のテキスト):記事のタイトル。ない場合は、Finが最初のH1またはファイル名の読みやすいバージョンを使用します。

  • description(任意のテキスト):記事タイトルの下に表示される短い説明。

  • publishedまたはstate(published、true、draft、またはfalse):記事が公開済みとして同期されるかドラフトとして同期されるか。公開済みはコンテンツがライブでFinが利用可能な状態を意味します。

  • public_url(任意のURL):Finがこのコンテンツを引用するときに顧客がアクセスする公開URL。これがないとFinは記事の出典を引用しません。

  • service_agentまたはservice(enabledまたはdisabled):Finが記事を利用できるかどうか。

  • copilot(enabledまたはdisabled):Copilotが記事を利用できるかどうか。

  • sales_agentまたはsales(enabledまたはdisabled):Sales Agentが記事を利用できるかどうか。

すべてのFrontmatterキーと値は任意です。認識されないキーはスキップされます。


PRチェック

Finは同期されたMarkdownファイルを変更するプルリクエストに対して軽量なチェックを実行します。すべてのFrontmatterキーが有効かつサポートされているかを確認します。チェックに失敗するとプルリクエストのチェックセクションに表示され、詳細をクリックして確認できます。

注意:これらのチェックはマージをブロックしません。GitSync: Content Validationチェックが失敗してもプルリクエストはマージ可能です。強制するには、GitHubのマージ前のステータスチェック必須設定を参照してください。


既知の制限事項

  • Markdown(.md)ファイルのみが同期されます。.mdxファイルはまだサポートされていません。

  • 同期された記事はデフォルトでFin、Copilot、Sales Agentでオフになっているため、公開前にレビューできます。

  • これはGitHubからFinへの一方向同期です。同期された記事はFinでは読み取り専用で、編集はGitHubで行う必要があります。

  • 記事は現在英語でのみ作成されています。

こちらの回答で解決しましたか?