Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit d7d8684

Browse files
committed
(docs): Making it more clear that the branch should not be deleted.
1 parent 4244323 commit d7d8684

File tree

3 files changed

+9
-5
lines changed

3 files changed

+9
-5
lines changed

docs/getting-started/smart-git-sync.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ For example, let's say you've just added a new _Task_ entity to your project. On
4444

4545
This method ensures that every single change you make in your Amplication project is automatically tracked and committed to the `amplication` branch in your Git repository. You can then easily review and merge these changes through pull requests.
4646

47-
:::info
48-
After the Amplication build completes, review the PR, resolve any conflicts, and merge it. **Keep the `amplication` branch and avoid deleting it**.
47+
:::note
48+
After the Amplication build completes, review the PR, resolve any conflicts, and merge it. **Keep the `amplication` branch and avoid deleting it**. In case of conflicts, handle them on the `amplication` branch and perform commits there. Regular development work should not be done on this branch.
4949
:::
5050

5151
## The `amplication` branch
@@ -61,7 +61,7 @@ For example, Amplication will base the `amplication` branch from `main` if your
6161
You can merge Amplication-made changes by merging pull requests created by Amplication from the `amplication` branch to your repository's default branch.
6262

6363
:::note
64-
Refrain from modifying the `amplication` branch directly. Creating new commits or merging changes from other branches can introduce bugs and inconsistencies. In case of conflict, delete the `amplication` branch and resolve the merge conflict in the next PR.
64+
Refrain from modifying the `amplication` branch directly. Creating new commits or merging changes from other branches can introduce bugs and inconsistencies. In case of conflict, resolve it on the `amplication` branch. Do not delete the `amplication` branch.
6565
:::
6666

6767
![](./assets/sync-with-git-provider/github-pull-request.png)

docs/getting-started/sync-with-bitbucket.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,4 +120,4 @@ And there you have it – a new pull request ready for review.
120120

121121
![bitbucket-pull-request](./assets/sync-with-git-provider/bitbucket-pull-request.png)
122122

123-
Amplication creates pull requests from the `amplication` branch into your repository's default base branch. Pro and Enterprise users can [change the base branch for these pull requests](/how-to/change-base-branch-for-pull-requests)
123+
Amplication creates pull requests from the `amplication` branch into your repository's default base branch. In case of conflict, resolve it on the `amplication` branch. Do not delete or modify the `amplication` branch. Pro and Enterprise users can [change the base branch for these pull requests](/how-to/change-base-branch-for-pull-requests).

docs/getting-started/sync-with-github.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,10 @@ Now let's review what happens from GitHub's side when Amplication generates a ne
142142
Amplication triggers the creation of a commit on the changed files whenever a new build is performed on a project.
143143
The changed files are all the files that were added, removed, or changed from the last build.
144144

145+
:::note
146+
Refrain from modifying the `amplication` branch directly. Creating new commits or merging changes from other branches can introduce bugs and inconsistencies. In case of conflict, resolve it on the `amplication` branch. Do not delete the `amplication` branch.
147+
:::
148+
145149
![A pull request generated by Amplication on GitHub](./assets/sync-with-git-provider/github-pull-request-amplication-branch.png)
146150

147151
Amplication reduces the chances of user changes being overridden by interacting with the user’s repository through an `amplication` branch. This branch is created in your selected repository by Amplication's GitHub App.
@@ -172,7 +176,7 @@ It will take you to the specific build log for this commit on Amplication.
172176

173177
## Merging your pull request
174178

175-
After clicking on `Merge`, you can safely delete this branch. You can then navigate back to your main branch where you will find your Amplication code.
179+
After clicking on `Merge`, do not delete the `amplication` branch. You can then navigate back to your main branch where you will find your Amplication code.
176180

177181
![](./assets/sync-with-git-provider/4d38da6f-9b1c-4844-91ec-ec9b101c4503.png)
178182

0 commit comments

Comments
 (0)