Skip to content

Commit 379539e

Browse files
committed
Added visuals
1 parent dfdfe67 commit 379539e

File tree

4 files changed

+50
-11
lines changed

4 files changed

+50
-11
lines changed

docs/testing-deployment-publishing/branching-collaboration/branching.md

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ This option is currently in **beta**. In addition to fixing any issues, here’s
256256

257257
When performing a Git merge in FlutterFlow, you’ll see a screen with multiple panels and info sections. Here are the details of it.
258258

259-
[image]
259+
![merging-window](imgs/merging-window.avif)
260260

261261
**Top Panel**
262262

@@ -271,19 +271,19 @@ When performing a Git merge in FlutterFlow, you’ll see a screen with multiple
271271
- **Fix Errors After the Merge**: If you prefer, you can complete the merge first and address the errors later. For example, finish the merge process as it is. After merging, go back to the project and resolve any issues.
272272
- **Cancel**: Abandons the merge process and discards any conflict resolutions you’ve already applied during this merge session.
273273
- **Merge**: Finalizes the merge once all merge conflicts and YAML validation errors are cleared. Project errors can remain if you choose to resolve them later.
274-
- **Bulk Accept Changes**: Accessible via the arrow next to Merge,” this option lets you accept all changes from one branch at once—handy if you already know which branch’s changes take precedence.
274+
- **Bulk Accept Changes**: Accessible via the **arrow** next to **Merge** button. this option lets you accept all changes from one branch at once—handy if you already know which branch’s changes take precedence.
275275

276-
**Left-Hand Side Panel**
276+
**Left Panel**
277277

278278
The left-hand side panel displays all the project configuration YAML files, which are crucial for managing your project’s settings and structure.
279279

280280
YAML (Yet Another Markup Language) files use a simple, human-readable format to define configuration data. They are particularly useful during a merge because they allow you to directly review, understand, and resolve any changes or conflicts in your project’s configuration.
281281

282282
- **Filter Files:** You can use filters to narrow down the list of YAML files based on specific criteria:
283283

284-
- **All Files:** Shows every YAML file in the project.
285-
- **Files with Changes:** Displays only files where a change has been made on either branch.
286-
- **Files with Conflicts:** Shows only files that have merge conflicts, where the changes in one branch directly contradict the changes in the other.
284+
- **All Files (Unchanged Files)**: Shows every YAML file in the project.
285+
- **Files with Changes**: Displays only files where a change has been made on either branch.
286+
- **Files with Conflicts**: Shows only files that have merge conflicts, where the changes in one branch directly contradict the changes in the other.
287287

288288
:::info
289289
- A **change** refers to any update, addition, or deletion made in one of the branches. For example, modifying a field name or changing the properties of a widget.
@@ -294,8 +294,21 @@ YAML (Yet Another Markup Language) files use a simple, human-readable format to
294294

295295
Clicking on a file in the panel opens it in the editor, allowing you to view, edit, and resolve issues directly.
296296

297+
**Right Upper Panel**
297298

298-
**Lower Panel**
299+
The Upper Right Panel offers a quick, side-by-side comparison of file changes from both branches, along with easy one-click accept buttons and previews. This panel makes it simple to decide which changes to keep or discard.
300+
301+
:::info
302+
We highlight edits using green and red (Git) color coding:
303+
304+
- **Green** indicates lines or values **added** (or unique) in one branch.
305+
- **Red** indicates lines or values **removed** (or replaced) by that branch.
306+
:::
307+
308+
- **Accept Change Button**: Quickly accept changes from one branch if you know it has the correct edits.
309+
- **Eye (Preview) Icon**: Open or view the file in the FlutterFlow builder to see how the changes look. For example, you can preview a theme color change visually rather than just reading its name in YAML.
310+
311+
**Right Lower Panel**
299312

300313
The **Lower Panel** displays the final merged files after Git applies its merging logic. It gives you a chance to manually inspect and edit the outcome—whether or not a conflict occurs.
301314

@@ -307,7 +320,7 @@ Git attempts to combine changes from both branches automatically. If Git can’t
307320

308321
:::info
309322

310-
Git may label branches as `HEAD` or a commit reference, which can differ from the friendly branch names you given.
323+
During merge conflict, Git may label branches as `HEAD` or a commit reference, which can differ from the friendly branch names you given.
311324

312325
- **HEAD**: Refers to the current branch (or commit) you’re on—essentially your “main viewpoint” in Git.
313326
- **Other Branch**: Denotes the second branch (or commit) you’re merging in, which might be labeled using a commit hash.
@@ -316,7 +329,7 @@ Git may label branches as `HEAD` or a commit reference, which can differ from th
316329

317330
You can modify files in the lower panel at any time—even if there’s no conflict. You could also choose which branch’s changes to keep here. You might decide to keep certain lines from `HEAD` (your current branch) or from the other branch or combine them manually.
318331

319-
After editing, click **Save** to confirm your changes. A red reset button appears if you want to undo your edits and restore the file to its initial state before you began editing.
332+
After editing, click **Save Changes** to confirm your changes. A red reset button appears if you want to undo your edits and restore the file to its initial state before you began editing.
320333

321334
### Resolve Merge Conflicts
322335
A merge conflict occurs when multiple team members make changes to the same part of the project.
@@ -373,16 +386,42 @@ When you initiate a merge using Git, the system attempts to automatically reconc
373386
You can review each file with merge conflicts and choose to:
374387

375388
- Accept all changes from one branch.
376-
- Pick specific changes from each branch.
389+
![accept-all-from-one-branch](imgs/accept-all-from-one-branch.avif)
390+
- Pick specific changes from any branch.
391+
![accept-specific-change-from-file](imgs/accept-specific-change-from-file.avif)
377392
- Manually edit the YAML files. **Note that** it’s essential to correct any YAML validation errors that arise from manual edits.
393+
<div style={{
394+
position: 'relative',
395+
paddingBottom: 'calc(56.67989417989418% + 41px)', // Keeps the aspect ratio and additional padding
396+
height: 0,
397+
width: '100%'}}>
398+
<iframe
399+
src="https://demo.arcade.software/hphsdsKGyT8Vid7c0NxX?embed&show_copy_link=true"
400+
title=""
401+
style={{
402+
position: 'absolute',
403+
top: 0,
404+
left: 0,
405+
width: '100%',
406+
height: '100%',
407+
colorScheme: 'light'
408+
}}
409+
frameborder="0"
410+
loading="lazy"
411+
webkitAllowFullScreen
412+
mozAllowFullScreen
413+
allowFullScreen
414+
allow="clipboard-write">
415+
</iframe>
416+
</div>
417+
<p></p>
378418

379419
Finally, complete the merge by clicking **Merge**.
380420
:::tip
381421
- If you merged a child branch into its parent and are confident everything looks correct, you may delete the child branch.
382422
- If you find any issues after the merge, you can revert the branch to an earlier commit. However, be aware that any changes made after that commit will be lost.
383423
:::
384424

385-
[Arcade]
386425

387426
### Resolve Conflicts Manually
388427
If you choose to resolve manually, you can directly make changes in the **Accepted Changes** section. Note that if you cancel a manual resolution, you can choose to either keep or discard the changes you have made since starting the manual resolution.

0 commit comments

Comments
 (0)