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

Commit 5583494

Browse files
authored
Merge pull request #510 from amplication/docs/update-amplication-branch-info
Docs: Update Amplication Branch Info
2 parents 9108f27 + 0739cb8 commit 5583494

File tree

3 files changed

+25
-5
lines changed

3 files changed

+25
-5
lines changed

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

+7-3
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,10 @@ 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.
49+
50+
**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.
4951
:::
5052

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

6365
:::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.
66+
**Do not delete the `amplication` branch**.
67+
68+
Do not modify the `amplication` branch, except to resolve conflicts. Handle conflicts directly on the `amplication` branch. Avoid creating new commits or merging changes from other branches to prevent bugs and inconsistencies.
6569
:::
6670

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

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

+11-1
Original file line numberDiff line numberDiff line change
@@ -120,4 +120,14 @@ 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+
## Merging Amplication's Pull Request into your branch
124+
125+
Amplication creates pull requests from the `amplication` branch into your repository's default base branch.
126+
Amplication triggers the creation of a commit on the changed files whenever a new build is performed on a project.
127+
The changed files are all the files that were added, removed, or changed from the last build.
128+
129+
:::note
130+
**Do not delete the `amplication` branch**.
131+
132+
Do not modify the `amplication` branch, except to resolve conflicts. Handle conflicts directly on the `amplication` branch. Avoid creating new commits or merging changes from other branches to prevent bugs and inconsistencies.
133+
:::

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

+7-1
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,12 @@ 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+
**Do not delete the `amplication` branch**.
147+
148+
Do not modify the `amplication` branch, except to resolve conflicts. Handle conflicts directly on the `amplication` branch. Avoid creating new commits or merging changes from other branches to prevent bugs and inconsistencies.
149+
:::
150+
145151
![A pull request generated by Amplication on GitHub](./assets/sync-with-git-provider/github-pull-request-amplication-branch.png)
146152

147153
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 +178,7 @@ It will take you to the specific build log for this commit on Amplication.
172178

173179
## Merging your pull request
174180

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.
181+
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.
176182

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

0 commit comments

Comments
 (0)