GitLab同期の有効化

GitBookのためのGitLab統合を設定および認可する

はじめに

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

A GitBook screenshot showing GitLab Sync configuration options
GitLab同期の設定オプション。

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

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

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

トークンに次のアクセス権を有効にしていることを確認してください:

  • api

  • read_repository

  • write_repository

作成したトークンに特定のロールが割り当てられている場合は、次のロールも持っていることを確認してください: メンテナ(Maintainer) または 管理者(Admin) ロール。

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

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

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

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

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

初回同期を実行する

初めて同期を行うとき、次の2つの方向のいずれかで同期するオプションがあります:

  1. GitBook -> GitLab はあなたのスペースのコンテンツを同期します 選択したブランチへ。これは空のリポジトリから始めて GitBook のコンテンツをすばやく取り込みたい場合に便利です。

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

書いてコミットする

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

GitBook上で編集すると、すべての変更要求のマージは選択したGitLabブランチへのコミットとなります。

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

最終更新

役に立ちましたか?