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

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

対応者:Ivan Branimir Skoric

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

開始方法

GitHub リポジトリを接続するには、Knowledge Hub > See all > From GitHub に移動します。

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

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

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

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

(OPTIONAL) また、sync されたコンテンツの作成/更新方法や Frontmatter スキーマの使い方を Claude Code に指示するための CLAUDE.md ファイルを作成/更新することもできます。

完了したら、「Clone and connect」 をクリックします。

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

権限

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

Permission

Type

Why?

メタデータへのアクセス

読み取り専用

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

Checks

読み取り・書き込み

Frontmatter スキーマチェックの実行に必要です。詳細は こちら を参照してください。

コード

読み取り・書き込み

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

プルリクエスト

読み取り・書き込み

上記で説明した CLAUDE.md ファイルを作成するため、および Fin への同期と PR チェックを行うために必要なウェブフックを受け取るために必要です。

Workflows

読み取り・書き込み

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

同期の仕組み

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

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

(OPTIONAL) 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 のキーと値の一覧です:

Key

Allowed values

Description

title

任意のテキスト

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

description

任意のテキスト

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

published / state

published / true / draft / false

記事が公開状態で同期されるか下書きで同期されるかを指定します。

public_url

任意の URL

Fin がこのコンテンツをソースとして引用する際に顧客を誘導したい公開 URL を指定します。指定しない場合、Fin はソースを引用しません(記事は未掲載扱いになります)。

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 のドキュメントに記載されているように、これらのチェックを必須にすることはできます。詳細は こちら を参照してください。

既知の制限事項

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

  • AI Agent/Copilot/Sales Agent に対しては、レビューのために同期後はデフォルトで無効になっています。

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

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

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