GitHub

ドキュメントを GitHub リポジトリと同期する

Mintlify は GitHub アプリを使用して、ドキュメントを GitHub リポジトリと自動同期します。

GitHubアプリのインストール

ドキュメント用リポジトリを所有するGitHubアカウントまたは組織に、Mintlify GitHub App をインストールします。アプリをインストールするには、組織の所有者権限、またはリポジトリの管理者権限が必要です。必要な権限がない場合は、リポジトリの所有者にインストールリクエストを承認してもらってください。

ダッシュボードから Mintlify GitHub App をインストールします。

ドキュメントをホストしているリポジトリにのみアクセス権を付与することを推奨します。

権限

GitHub アプリをインストールすると、次の権限の付与を求められます。

読み取り権限:

• metadata: リポジトリの基本情報

読み取りおよび書き込み権限:

• checks: プルリクエストにステータスチェックを作成
• code: docs ブランチへのコミット時のファイル変更を読み取り
• deployments: プルリクエストのプレビューデプロイを生成
• pull requests: ウェブエディタからブランチとプルリクエストを作成
• workflows: ドキュメントのデプロイ用 GitHub Actions を管理

このアプリは、あなたが明示的にアクセスを許可したリポジトリにのみアクセスします。ブランチ保護ルールが有効な場合、アプリは保護対象のブランチへ直接プッシュできません。

リポジトリへのアクセス管理

GitHub App をインストールする際、すべてのリポジトリか特定のリポジトリのみにアクセス権を付与できます。ドキュメントがあるリポジトリに限定して付与することを推奨します。この設定はいつでも GitHub App の設定で変更できます。

ドキュメントのソース設定

ドキュメントのビルド元となる組織・リポジトリ・ブランチは、ダッシュボードの Git Settings セクションで変更できます。

トラブルシューティング

GitHub アプリで問題が発生した場合は、接続をリセットすると解決することがほとんどです。

1. GitHub から Mintlify アプリをアンインストールする

   1. GitHub の installations にアクセスし、Mintlify アプリの横にある Configure を選択します。ページ下部までスクロールして Uninstall を選択します。
   2. Authorized GitHub Apps にアクセスし、Mintlify アプリの横にある Revoke を選択します。
2. Mintlify アプリを再インストールする

   1. Mintlify ダッシュボードの Git Settings に移動し、GitHub アプリをインストールします。
   2. ダッシュボードの My Profile でアカウントの承認を行います。