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

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

対応者:Ivan Branimir Skoric

GitHubコンテンツ同期では、GitHubからMarkdown(.md)ファイルを直接Finに同期できます。

はじめに

GitHubリポジトリを接続するには、Knowledge Hub > すべて表示 > From GitHubに移動します。

次に、Finに接続したいアカウント用のFin GitHub同期アプリをインストールする必要があります。

次に、アプリをインストールするアカウントを選択します。組織アカウントの場合、組織管理者の承認が必要な場合があります。

アカウントを選択したら、すべてのリポジトリへのアクセスを許可するか、特定のサブセットのみを許可するかを選択できます。

GitHubでの設定が完了すると、ポップアップウィンドウが閉じ、同期したいMarkdownファイルのあるリポジトリとフォルダ(該当する場合)を選択するよう求められます。

(任意) 同期されたコンテンツの作成・更新方法やFrontmatterスキーマの使用方法についてClaude Codeに指示するCLAUDE.mdファイルを作成/更新することもできます。

完了したら、「クローンして接続」をクリックします。

注意:最初に選択したものとは異なるリポジトリへのアクセスを許可する必要がある場合は、「Manage GitHub repository access on GitHub」をクリックしてください。同じポップアップウィンドウが開き、許可リストに追加のリポジトリを追加できます。

権限

Fin GitHub Syncアプリには以下のGitHub権限が必要です。

権限

タイプ

理由

メタデータアクセス

読み取り専用

すべてのGitHubアプリがデフォルトで持つアプリスコープ

チェック

読み取り・書き込み

こちらで説明されているFrontmatterスキーマチェックを実行するために必要です。

コード

読み取り・書き込み

Finに同期されたMarkdownファイルのフォーマット方法をClaude Codeに指示するCLAUDE.mdファイルを作成/更新するために必要です。これはセットアップ時にスキップ可能なオプション機能ですが、この権限は必須です。

プルリクエスト

読み取り・書き込み

上記で説明したCLAUDE.mdファイルの作成およびFinへの同期とPRチェック実行に必要なWebhookの受信に必要です。

Workflows

読み取り・書き込み

リポジトリにGitHub Actionsのワークフローを追加し、FinのSuggestions Pull Requestsを自動承認・マージする(オプションの自動マージ設定)ために必要です。

同期の仕組み

リポジトリを初めて接続すると、Finは現在存在するすべてのMarkdownファイルを同期します。

同期されたフォルダ/リポジトリのMarkdownファイルが更新される変更がマージされると、自動的にこれらの編集を適用します。

(任意) Frontmatterスキーマ

注意:Frontmatterスキーマは必須ではありません。Markdownファイルで使用していない場合は、このセクションをスキップできます。

Frontmatterは、MarkdownファイルからFinに記事を同期する際の追加プロパティを指定できます。

Frontmatterは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…

以下は現在サポートされているFrontmatterのキーと値の一覧です。

キー

許可される値

説明

title

任意のテキスト

記事のタイトルを指定します。指定がない場合は最初のH1を取得するか、Markdownファイル名を人間が読める形に変換します。

description

任意のテキスト

Finの記事タイトルの下に表示される短い説明文です。

published / state

published / true / draft / false

記事が公開済みかドラフトとして同期されるかを指定します。公開済みはコンテンツがFinでライブで利用可能であることを意味し、Help Centerに表示されることを意味しません。

public_url

任意のURL

Finがこのコンテンツをソースとして引用する際に顧客がアクセスする公開URLを指定します。指定しない場合、Finはこの記事のソースを引用しません。この記事がHelp Centerに表示されるかには影響しません。同期された記事は常に非公開です。

service_agent / service

enabled / disabled

記事がFin AI Agentからアクセス可能かを指定します。

copilot

enabled / disabled

記事がFin Copilotからアクセス可能かを指定します。

sales_agent / sales

enabled / disabled

記事がFin Sales Agentからアクセス可能かを指定します。

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

PRチェック

同期されたMarkdownファイルを対象としたPRに対して軽量なチェックを実行します。

Frontmatterスキーマのすべてのキーが有効かつサポートされているかを確認するチェックを実行します。

チェックに失敗すると、プルリクエストのチェックセクションに以下のように表示されます。

検出された違反の詳細を確認するには、チェックをクリックできます。

注意:これらのチェックはブロッキングではありません。GitSync: Content Validationチェックが失敗してもPRはマージ可能です。

ただし、GitHubのドキュメントこちらで説明されているように、これらのチェックを強制することは可能です。

既知の制限事項

  • 同期された記事はHelp Centerで非公開です。Help Centerやコレクションに追加できないため、顧客はHelp Centerの閲覧や検索で見つけられません。Fin AI AgentとCopilotは関連するサーフェスを有効にすれば使用可能です。記事をHelp Centerコレクションに表示したい場合は、GitHubから同期するのではなくIntercomで作成してください。同期された記事はIntercomで読み取り専用であり、閲覧や検索可能にする設定やfrontmatterフィールドはありません。

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

  • 同期された記事はAI Agent/Copilot/Sales Agent向けにデフォルトで無効化されており、公開前に手動でレビューできます。

  • これはGitHubからFinへの一方向同期のみです。記事は現在GitHubで編集する必要があります。

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

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