Skip to content

Commit 804d5d6

Browse files
Merge pull request mendix#9097 from mendix/Maria_commit-and-combine
Commit and combine
2 parents de5cc34 + 2e4286b commit 804d5d6

7 files changed

Lines changed: 34 additions & 12 deletions

File tree

content/en/docs/refguide/modeling/menus/version-control-menu/commit-dialog.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,14 @@ weight: 20
88

99
The commit dialog is used for committing changes to the Team Server. You can enter a message and, if applicable, select related stories.
1010

11-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-dialog-stories.png" alt="Version Control Menu" class="no-border" width="400" >}}
12-
1311
## Branch
1412

1513
At the top of the dialog box you will see the branch which you are committing. This will be one of the following:
1614

1715
| Branch Description | Notes |
1816
| --- | --- |
19-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-main.png" alt="Version Control Menu" class="no-border" >}} | you are committing the main line |
20-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-branch.png" alt="Version Control Menu" class="no-border" >}} | you are committing the specified branch |
17+
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-main.png" alt="Main line icon" class="no-border" >}} | you are committing the main line |
18+
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-branch.png" alt="Commit branch icon" class="no-border" >}} | you are committing the specified branch |
2119

2220
## Message
2321

@@ -27,20 +25,44 @@ Enter a message describing the changes you have made. This message may contain m
2725

2826
### Related Stories {#stories}
2927

30-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-dialog-stories.png" alt="Version Control Menu" class="no-border" width="400" >}}
31-
3228
Tick the boxes next to the stories that are related to your commit. Mendix recommends committing a small number of changes at a time, so there is usually just one related story.
3329

3430
### Changes in Model
3531

36-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-dialog-model-changes.png" alt="Version Control Menu" class="no-border" width="400" >}}
37-
3832
If there are changes in the model this tab shows a summary of those changes. For more information on how changes are reported in Studio Pro, see [Changes Pane](/refguide/changes-pane/).
3933

40-
### Changes on Disk
34+
There are several scenarios and options that you can choose when committing. Two of these options are represented in the image below:
35+
36+
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-options.jpg" alt="Several options when committing" >}}
37+
38+
#### Commit and Push
39+
40+
{{% alert color="info" %}}
41+
42+
**Commit and Push** is the recommended flow to stay in-sync with your team and avoid conflicts.
43+
44+
{{% /alert %}}
45+
46+
Your changes are committed and pushed to the server.
4147

42-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-dialog-disk-changes.png" alt="Version Control Menu" class="no-border" width="400" >}}
48+
#### Commit Locally
49+
50+
Changes are committed to your local working copy and are not pushed to the sever.
51+
52+
#### Commit and Combine {#combine}
53+
54+
If someone else committed a change since the last time you pulled your branch, you will have to pull and merge their changes before you can push to the server. This process is called **Commit and Combine** in the [Commit](/refguide/commit-dialog/) dialog box. **Commit and Combine** will first create a local commit and then automatically do a pull. After resolving any conflicts, you can push the combined version to the server.
55+
56+
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/commit-dialog/commit-and-combine.jpg" alt="Commit and combine changes" >}}
57+
58+
{{% alert color="warning" %}}
59+
60+
After you reviewed the changes, you will need to push your changes, as **Commit and Combine** only updates your local copy and does not push your changes to the server.
61+
62+
{{% /alert %}}
63+
64+
### Changes on Disk
4365

44-
If there are changes on disk this page shows a summary of those changes. Click **Open containing folder** to open the folder containing the selected file in Windows Explorer.
66+
If there are changes on disk this tab shows a summary of those changes. Click **Open containing folder** to open the folder containing the selected file in Windows Explorer.
4567

4668
The tab page is hidden if there are no disk changes. Often, there are model changes but the only change on disk is the app file (*.mpr*) reflecting these model changes. In this case, it is also hidden, because it does not add useful information.

content/en/docs/refguide/version-control/using-version-control-in-studio-pro/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ A tool you can consider using is TortoiseGitMerge, shipped as part of [TortoiseG
143143
Comparing files on disk with the original is currently not supported on macOS.
144144
{{% /alert %}}
145145

146-
Committing is only allowed if your working copy is up to date with the repository. If someone else committed a change since the last time you pulled, you will have to pull first. This is because the revision you create with the commit should incorporate both your changes and the changes by the other person. Updating will combine the latest changes in the repository with your changes. After reviewing the result and fixing any conflicts, you can commit again.
146+
Committing is only allowed if your working copy is up to date with the repository. If someone else committed a change since the last time you pulled, you will have to pull first (this process is called **Commit and Combine** in the [Commit](/refguide/commit-dialog/#combine) dialog box). This is because the revision you create with the commit should incorporate both your changes and the changes by the other person. Updating will combine the latest changes in the repository with your changes. After reviewing the result and fixing any conflicts, you can commit again.
147147

148148
### Pushing {#pushing}
149149

72.7 KB
Loading
45.5 KB
Loading

0 commit comments

Comments
 (0)