Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions tidb-cloud/branch-github-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ summary: TiDB Cloudのブランチ機能をGitHubと連携させる方法を学

> **注記:**
>
> この統合は[TiDB Cloudブランチング](/tidb-cloud/branch-overview.md)ベースに構築されています。このドキュメントを読む前に、 TiDB Cloud Branching について理解していることを確認してください。
> この統合は[TiDB Cloud Branching](/tidb-cloud/branch-overview.md)ベースに構築されています。このドキュメントを読む前に、 TiDB Cloud Branching について理解していることを確認してください。

アプリケーション開発にGitHubを使用している場合、 TiDB Cloud BranchingをGitHubのCI/CDパイプラインに統合することで、本番データベースに影響を与えることなく、ブランチを使用したプルリクエストを自動的にテストできます。

統合プロセスでは、 [TiDB Cloudブランチング](https://github.com/apps/tidb-cloud-branching)GitHub アプリのインストールを求められます。このアプリは、GitHub リポジトリのプルリクエストに基づいて、 TiDB Cloud Starterインスタンスのブランチを自動的に管理できます。たとえば、プルリクエストを作成すると、アプリはTiDB Cloud Starterインスタンスに対応するブランチを作成します。このブランチでは、本番データベースに影響を与えることなく、新機能の開発やバグ修正を個別に行うことができます。
統合プロセスでは、 [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching)GitHub アプリのインストールを求められます。このアプリは、GitHub リポジトリのプルリクエストに基づいて、 TiDB Cloud Starterインスタンスのブランチを自動的に管理できます。たとえば、プルリクエストを作成すると、アプリはTiDB Cloud Starterインスタンスに対応するブランチを作成します。このブランチでは、本番データベースに影響を与えることなく、新機能の開発やバグ修正を個別に行うことができます。

この文書では、以下のトピックについて説明します。

Expand Down Expand Up @@ -52,20 +52,20 @@ TiDB Cloud BranchingをGitHubリポジトリと統合するには、以下の手

<img src="https://docs-download.pingcap.com/media/images/docs/tidb-cloud/branch/github-connect.png" width="40%" />

## TiDB Cloudのブランチングアプリの動作 {#tidb-cloud-branching-app-behaviors}
## TiDB Cloud Branchingアプリの動作 {#tidb-cloud-branching-app-behaviors}

TiDB Cloud Starterインスタンスを GitHub リポジトリに接続すると、このリポジトリ内の各プルリクエストに対して、 [TiDB Cloudブランチング](https://github.com/apps/tidb-cloud-branching)GitHub アプリは、 TiDB Cloud Starterインスタンスに対応するブランチを自動的に管理できます。プルリクエストの変更に関するデフォルトの動作は次のとおりです。
TiDB Cloud Starterインスタンスを GitHub リポジトリに接続すると、このリポジトリ内の各プルリクエストに対して、 [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching)GitHub アプリは、 TiDB Cloud Starterインスタンスに対応するブランチを自動的に管理できます。プルリクエストの変更に関するデフォルトの動作は次のとおりです。

| プルリクエストの変更 | TiDB Cloudのブランチングアプリの動作 |
| プルリクエストの変更 | TiDB Cloud Branchingアプリの動作 |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| プルリクエストを作成する | リポジトリでプルリクエストを作成すると、 [TiDB Cloudブランチング](https://github.com/apps/tidb-cloud-branching)アプリは、 TiDB Cloud Starterインスタンス用のブランチを作成します。 `branch.mode`が`reset`に設定されている場合、ブランチ名は`${github_branch_name}_${pr_id}`の形式に従います。 `branch.mode`が`reserve`に設定されている場合、ブランチ名は`${github_branch_name}_${pr_id}_${commit_sha}`の形式に従います。ブランチの数には[制限](/tidb-cloud/branch-overview.md#limitations-and-quotas)があることに注意してください。 |
| プルリクエストに新しいコミットをプッシュする | `branch.mode`が`reset`に設定されている場合、リポジトリのプルリクエストに新しいコミットをプッシュするたびに、 [TiDB Cloudブランチング](https://github.com/apps/tidb-cloud-branching)アプリはブランチをリセットします。 `branch.mode`が`reserve`に設定されている場合、アプリは最新のコミット用に新しいブランチを作成します。 |
| プルリクエストを閉じるかマージする | プルリクエストを閉じたりマージしたりすると、 [TiDB Cloudブランチング](https://github.com/apps/tidb-cloud-branching)アプリはこのプルリクエストのブランチを削除します。 |
| プルリクエストを再開する | プルリクエストを再開すると、 [TiDB Cloudブランチング](https://github.com/apps/tidb-cloud-branching)アプリはプルリクエストの最後のコミットのブランチを作成します。 |
| プルリクエストを作成する | リポジトリでプルリクエストを作成すると、 [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching)アプリは、 TiDB Cloud Starterインスタンス用のブランチを作成します。 `branch.mode`が`reset`に設定されている場合、ブランチ名は`${github_branch_name}_${pr_id}`の形式に従います。 `branch.mode`が`reserve`に設定されている場合、ブランチ名は`${github_branch_name}_${pr_id}_${commit_sha}`の形式に従います。ブランチの数には[制限](/tidb-cloud/branch-overview.md#limitations-and-quotas)があることに注意してください。 |
| プルリクエストに新しいコミットをプッシュする | `branch.mode`が`reset`に設定されている場合、リポジトリのプルリクエストに新しいコミットをプッシュするたびに、 [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching)アプリはブランチをリセットします。 `branch.mode`が`reserve`に設定されている場合、アプリは最新のコミット用に新しいブランチを作成します。 |
| プルリクエストを閉じるかマージする | プルリクエストを閉じたりマージしたりすると、 [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching)アプリはこのプルリクエストのブランチを削除します。 |
| プルリクエストを再開する | プルリクエストを再開すると、 [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching)アプリはプルリクエストの最後のコミットのブランチを作成します。 |

## TiDB Cloud Branchingアプリの設定 {#configure-tidb-cloud-branching-app}

[TiDB Cloudブランチング](https://github.com/apps/tidb-cloud-branching)の動作を設定するには リポジトリのルートディレクトリに`tidbcloud.yml`ファイルを追加し、以下の手順に従って必要な設定をこのファイルに追加します。
[TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching)の動作を設定するには リポジトリのルートディレクトリに`tidbcloud.yml`ファイルを追加し、以下の手順に従って必要な設定をこのファイルに追加します。

### branch.blockList {#branch-blocklist}

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/branch-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: TiDB Cloud Branching (Beta) Overview
summary: TiDB Cloudのブランチの概念を学びましょう。
---

# TiDB Cloudブランチング(ベータ版)の概要 {#tidb-cloud-branching-beta-overview}
# TiDB Cloud Branching(ベータ版)の概要 {#tidb-cloud-branching-beta-overview}

TiDB Cloudでは、TiDB Cloud Starterインスタンスのブランチを作成できます。TiDB Cloud Starterインスタンスのブランチは、元のTiDB Cloud Starterインスタンスから分岐したデータコピーを含む独立したインスタンスです。これにより、隔離された環境が提供され、元のTiDB Cloud Starterインスタンスへの影響を気にすることなく、自由に実験を行うことができます。

Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/integrate-tidbcloud-with-vercel.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ TiDB Cloud Vercel 統合経由で接続するには、 [Vercelの統合マーケ

### TiDB Cloudのブランチ機能に接続します {#connect-with-branching} {#connect-with-branching}

Vercel の[プレビュー展開](https://vercel.com/docs/deployments/preview-deployments)機能を使用すると、変更を Git プロジェクトの本番ブランチにマージすることなく、ライブデプロイメントでアプリの変更をプレビューできます。TiDB [TiDB Cloudブランチング](/tidb-cloud/branch-overview.md)を使用すると、Vercel プロジェクトのブランチごとに新しいインスタンスを作成できます。これにより、本番データに影響を与えることなく、ライブデプロイメントでアプリの変更をプレビューできます。
Vercel の[プレビュー展開](https://vercel.com/docs/deployments/preview-deployments)機能を使用すると、変更を Git プロジェクトの本番ブランチにマージすることなく、ライブデプロイメントでアプリの変更をプレビューできます。TiDB [TiDB Cloud Branching](/tidb-cloud/branch-overview.md)を使用すると、Vercel プロジェクトのブランチごとに新しいインスタンスを作成できます。これにより、本番データに影響を与えることなく、ライブデプロイメントでアプリの変更をプレビューできます。

> **注記:**
>
Expand Down
2 changes: 1 addition & 1 deletion tidb-cloud/releases/release-notes-2024.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ summary: TiDB Cloudの2024年のリリースノートについてご確認くだ

- **ブランチのリセット**:ブランチをリセットして、親ブランチの最新の状態と同期させることができます。

- **GitHubとの連携機能の改善**: [TiDB Cloudブランチング](https://github.com/apps/tidb-cloud-branching)GitHubアプリでは`reset`プルリクエストの同期時の動作を制御する[`branch.mode`](/tidb-cloud/branch-github-integration.md#branchmode)パラメータが導入されました。デフォルトモードでは、アプリはプルリクエストの最新の変更に合わせてブランチをリセットします。
- **GitHubとの連携機能の改善**: [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching)GitHubアプリでは`reset`プルリクエストの同期時の動作を制御する[`branch.mode`](/tidb-cloud/branch-github-integration.md#branchmode)パラメータが導入されました。デフォルトモードでは、アプリはプルリクエストの最新の変更に合わせてブランチをリセットします。

詳細については、 [TiDB Cloud Serverless Branchs の管理](/tidb-cloud/branch-manage.md)および[TiDB Cloud Serverless Branching (ベータ版) を GitHub と統合する](/tidb-cloud/branch-github-integration.md)参照してください。

Expand Down
Loading