GitLab 同期の有効化

GitBook用のGitLab統合を設定して認可する

はじめに

GitLab リポジトリと同期したいスペースで、右上のスペースメニューに移動し、次を選択します Git と同期。プロバイダ一覧から次を選択します GitLab 同期、そしてクリックします 構成.

GitLab 同期の構成オプション。

API アクセストークンを生成して入力する

GitLab のユーザー設定で API アクセストークンを生成できます。

GitLab には Project（プロジェクト）トークンと Personal（個人）トークンの 2 種類のアクセストークンがあります。統合を機能させるには Personal トークンを使用する必要がある点に注意してください。Personal トークンは GitLab のユーザー設定メニューから生成できます。

トークンに対して次のアクセス権を有効にしてください:

• api

• read_repository

• write_repository

作成するトークンに特定の役割が割り当てられている場合は、次のいずれかの役割が付与されていることも確認してください、 メンテナ (Maintainer) または 管理者 (Admin) の役割。

その後、GitLab 統合を構成する際に API アクセストークン欄にトークンを貼り付けることができます。

リポジトリとブランチを選択する

GitBook のコンテンツと同期したいリポジトリを選択してください。

リポジトリが見えませんか？ API トークンを作成する際に正しい権限を設定したか確認してください。

正しいリポジトリを選択したら、コミットをプッシュして同期するブランチを選択してください。

多くの GitLab リポジトリでは、 main ブランチが自動的に保護に設定されている場合があります。もしそうであれば、コンテンツを同期するための特定のブランチを追加することをお勧めします。その後これを main にマージして保護を維持できます。

初回同期を実行する

最初に同期する際は、次の 2 つの方向のいずれかで同期するオプションがあります:

1. GitBook -> GitLab はスペースのコンテンツを同期します へ 選択したブランチに。空のリポジトリから始めて GitBook コンテンツを素早く投入したい場合に最適です。

2. GitLab -> GitBook はスペースのコンテンツを同期します から 選択したブランチ。既にリポジトリにマークダウンのコンテンツがあり、それを GitBook に取り込みたい場合に最適です。

書き込みとコミット

準備完了です。スペースが ライブ編集 モードになっていた場合、ライブ編集はロックされます。これにより、チーム内の誰かが GitBook で 変更リクエスト をマージしたときに、GitBook がリポジトリへ確実にコンテンツを同期できるようになります。

GitBook 上で編集すると、変更リクエストのマージごとに選択した GitLab ブランチへのコミットが作成されます。

GitLab にコミットすると、すべてのコミットが履歴コミットとして GitBook スペースに同期されます。