Skip to content
Draft
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
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Apps can be located on the Team Server, on another Git server, or on the local d

### Selecting an App {#select-app}

You can select an app from the list of your apps. Once you have selected an app, you can either choose a [branch line](/refguide/version-control/#branches) that you would like to open or click **Open in Studio Pro** and the branch that is indicated in the **Current Branch** column will open:
You can select an app from the list of your apps. Once you have selected an app, you can either choose a [branch line](/refguide/version-control/glossary/#branches) that you would like to open or click **Open in Studio Pro** and the branch that is indicated in the **Current Branch** column will open:

{{< figure src="/attachments/refguide/modeling/menus/file-menu/open-app-dialog/select-app.png" class="no-border" width="700" >}}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 80

## Introduction

The **Branch Line Manager** is used to manage the [branch lines](/refguide/version-control/#branches) of an app that are stored on a version control server. You can create or delete branch lines for your app, and you can change the branch line that you are working on.
The **Branch Line Manager** is used to manage the [branch lines](/refguide/version-control/glossary/#branches) of an app that are stored on a version control server. You can create or delete branch lines for your app, and you can change the branch line that you are working on.

To view the **Branch Line Manager** dialog box, open **Version Control** > **Manage Branch Lines**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 10

## Introduction

Use the **Create Branch Line** dialog box to create a new [branch line](/refguide/version-control/#branches) via the **Branch Line Manager**:
Use the **Create Branch Line** dialog box to create a new [branch line](/refguide/version-control/glossary/#branches) via the **Branch Line Manager**:

{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/branch-line-manager-dialog/create-branch-line-dialog/create-branch-line.png" class="no-border" width="550" >}}

Expand Down
133 changes: 20 additions & 113 deletions content/en/docs/refguide/version-control/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,135 +18,42 @@ Version Control allows you to manage your app development in two ways:

Version control in Mendix is built on top [Git](https://git-scm.com). The concepts will be familiar to seasoned users of these version control systems (VCS). Mendix simplifies the VCS commands by building them into Studio Pro and the Mendix Portal.

## Concepts {#concepts}
### Mendix Team Server
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the structure within this page should be revised a bit. Most questions are 'server-related' but the PR chapter 5 isn't really related. And then chapter 6 is an overall 'documents in this category' section.


### Team Server {#team-server}
[Mendix Team Server](/developerportal/repository/team-server/) is the Mendix-hosted environment that stores all Mendix apps. It facilitates versioning your apps by integrating them into a version control system. Mendix Studio Pro integrates with the Team Server allowing you to create and update apps, commit changes, and merge model versions with one click.

[Team Server](/developerportal/repository/team-server/) is where all the committed versions of Mendix apps are stored. If you commit a revision of an app, it is stored on the Team Server.
### What Version Control System Is Team Server Built On? {#which-team-server}

To commit to the Team Server you will need to have a role in the app which allows you to edit the app. For more information, see the [Team Roles](/developerportal/general/app-roles/#team-roles) section *App Roles*.
Mendix Team Server is based on proven technology. Initially it was based only on top of Subversion (SVN), also called Team Server SVN. The Team Server only supports storing apps using Git technology, referred to as Team Server Git.

For more information on the Team Server and technologies involved, see [Version Control FAQ](/refguide/version-control-faq/).
### How Much Storage Space Is Provided with Team Server?

### Repository {#repository}
Storage space is unlimited for apps connected to a commercial license. 1 GB of free storage is provided for your company account for apps not (yet) connected to a commercial license.

Within the [Team Server](#team-server) each app is stored in a repository. This repository contains all the [committed revisions](#commit) for the [Branches](#branches) of the app.
### What Happens with My Valuable and Confidential Data?

### Revision {#revision}
Mendix adheres to strict security standards and considers you the sole owner of your data. Only Mendix Cloud Infrastructure Engineers can access data and will only do so for troubleshooting. Your data is backed up for one year, and the backups are retained for one year after app deletion. You can get a backup of your data at any time by using default Git tools, or, if your app was deleted, by filing a [Mendix Support](https://support.mendix.com/) ticket.

A revision is the version of your app at a moment in time, stored on the [Team Server](#team-server).
## Can I Use the Subversion Version of the Team Server?

Each revision of your app is given a unique alphanumeric identifier which enables you to find it in future. A new revision is created from Studio Pro when the app is committed to the repository.
No, in Mendix 11, we are supporting only Git-versioned apps. You need to migrate your SVN app to Git to use Mendix 11. For more information on how to migrate, see [Migrate to Git](/developerportal/general/migrate-to-git/) in *Apps*.

### Working Copy {#working-copy}
## Can I Use Third-Party Tools to Connect to the Team Server? {#third-party-tools}

A working copy is the version of your app which is currently being worked on in Studio Pro. There is one working copy for each development line of the app. This model is held locally, on each computer where development work is taking place.
Yes, as the Team Server is based on a full implementation of Git. You can directly use third-party tools like GitHub Desktop. For more information on how to set this up, see the [External Tools](/refguide/using-version-control-in-studio-pro/#external-tools) section in *Using Version Control in Studio Pro*.

### Merge {#merge}
## Is It Possible to Connect to a Third-Party or On-Premises Version Control Server?

Merging is the action of taking one [revision](#revision) of an app and applying the differences which have been made in a different revision. See the [Merging Branches](#merging-branches) section for more information.
Yes, it is possible to connect to a third-party Git version control repository, which is often called BYO-GIT (Bring Your Own Git).

If any of the differences cannot be applied, then there is a [conflict](#conflict).
For more information about limitations and the supported Git repositories, see the [Introduction](/refguide/on-premises-git/#intro) and [Preparing Your Repository](/refguide/on-premises-git/#preparing-your-repo) sections in *Working with Git On-Premises Version Control Server*.

### Conflict {#conflict}
## Does Mendix 11 Support Pull Requests and Peer Reviews?

A conflict occurs when two versions of the app cannot be combined automatically. This happens when the same document has been changed in a Studio Pro working copy and a committed [revision](#revision) and these changes cannot be reconciled. These are some examples:
Studio Pro supports peer review and merging through the version control functionalities available in Studio Pro. For more information on how to set this process up, see [Using Version Control in Studio Pro](/refguide/using-version-control-in-studio-pro/).
Currently, Mendix does not support pull or merge requests through the Team Server for Mendix. When using third-party tools it is possible to review the following code extensions:

* The properties of a widget are changed in the revision and the working copy but to different settings
* A document is moved or deleted in the revision but has been changed in a different way in the working copy

When a conflict occurs, a developer has to intervene to decide how it should be resolved before it can be committed to the Team Server as a new revision.

### Pull {#pull}

Pulling is the action, invoked in Studio Pro, which gets the latest revision of the current [development line](#development-line) from the repository and merges the differences into the current working copy.

### Commit/Push {#commit}

Committing is the action, invoked in Studio Pro, of creating a set of changes and pushing all your changes to the [repository](#repository) and making a new [revision](#revision). It is possible to store the committed data in a local repository, but not yet push it to the central [repository](#repository).

If there are no conflicts, the changes are then sent to the repository to make a new revision.

### Development Line {#development-line}

Development of an app is done in a development line where a set of related changes is made. There are two types of development lines: the [main line](#main-line) and [branch lines](#branch-line).

#### Main Line {#main-line}

The main line is the initial development line for the app and is usually kept as the version which will be deployed to the production environment. Simple apps, and apps which do not require a high degree of collaboration, may only have a main line.

#### Branch Line {#branch-line}

A branch line is a way of making an independent set of changes which can be tested away from the main line.

See the [Branches](#branches) section below for more information on how branch lines can be used.

### Tag {#tag}

A Tag is a way of identifying a commit in addition to the [revision](#revision) number. It is specified by the developer and has four parts:

* Major: used to identify significant new functionality, a new user interface, or other important change
* Minor: used to identify new functionality which augments the main function of the app
* Patch: used to identify a fix to an error in a previously-released app
* Revision: this is added automatically and is the revision number of the commit

### Repository Service

The Repository Service manages communication between Studio Pro and other supporting services (for example, Team Server). The developer will not generally be aware that they are communicating via the Repository Service.

### Mendix MPR Storage {#mpr-format}

An app modeled in Mendix is stored in an *.mpr* file, a database that contains data on all documents, such as microflows, workflows, pages. Studio Pro or the [mx Command-Line Tool](/refguide/mx-command-line-tool/) is required to inspect changes in the *.mpr*.

{{% alert color="warning" %}}
Manually modifying files belonging to the *.mpr* storage format such as the *.mpr* file or the *mprcontents* directory (for example, when resolving file conflicts through third-party tooling), will lead to a corrupted state. To recover from a corrupted state a previous commit will need to be restored.
{{% /alert %}}
{{% alert color="warning" %}}
Renaming the app by renaming the *.mpr* file is not supported. Renaming your app when using version control is only supported via the Mendix Portal. For more information, see the [Page Header](/developerportal/general-settings/#settings-page-header) section in *Settings*.
{{% /alert %}}

## Branches {#branches}

With more complex apps, you may want to manage your code in a more sophisticated way. For example, you may want to develop new features separately from the currently deployed version of your app so that you can fix any bugs without having to release all the new features. This is done using [Branch Lines](#branch-line).

If you are already familiar with using branches, you can check the [Branching Best-Practices](/refguide/using-version-control-in-studio-pro/#branching-best-practices) section of *Using Version Control in Studio Pro* for advice on how to use branches when developing your Mendix app.

### Main Line

All apps are developed along the main line. Here you have all development happening along a single line, with all changes built upon the previous revision:

{{< figure src="/attachments/refguide/version-control/image7.png" class="no-border" >}}

### Branch Line

When you add a branch line, you take a copy of an existing [revision](#revision) and work separately on that copy. Changes made to one branch do not impact any other branches.

In Mendix each commit within a [repository](#repository) is given a unique identifier.

{{< figure src="/attachments/refguide/version-control/image8.png" class="no-border" >}}

### Merging Branches {#merging-branches}

You may have a branch line which will continue independently and never need to be combined with any other development lines. For example, you may create a branch for a particular release of your app and only ever use it to fix bugs in that release.

On the other hand, you may want to add the features from one branch line into another development line. These are two cases for doing this:

* You develop new features in a branch line and want to include them in your main development line
* You want to take advantage of a bug fix which was made on another branch line

You can merge a specific revision of a branch line into your current [working copy](#working-copy). If, for example, you were working on the main line updated to revision 6, you can [merge](#merge) revision 5 from another branch line into your working copy. Then you can commit the result to create revision 7. If you want to merge several different committed changes from a branch, you will need to select a range of revisions which includes all the changes.

{{< figure src="/attachments/refguide/version-control/image9.png" class="no-border" >}}

{{% alert color="info" %}}

You are expected to merge branch lines into the main line before upgrading to a version that is one or more **major** versions newer than the current one.
It is also highly recommended to either commit or revert all changes before such an upgrade so there are no uncommitted changes during the upgrade.

{{% /alert %}}

There may be conflicts during the merge, and these will have to be resolved before you can commit the changes to your app.

Note that errors can be introduced by the [merge](#merge) process even if no conflicts are identified during the merge. Errors are inconsistencies which are flagged in Studio Pro and will prevent the app from being deployed. They could lead to a revision not being deployable, so it is important to check for errors after you have done a merge.
* code for Java and JavaScript actions
* HTML/CSS for theming

## Documents in This Category
14 changes: 14 additions & 0 deletions content/en/docs/refguide/version-control/configure/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "Configuring Version Control"
url: /refguide/uversion-control/configure/
weight: 30
description: "Describes how to configure version control for your Mendix application."
---

## Introduction

This document describes how to configure version control in Mendix Studio Pro.

For more information on related concepts and the theory behind how version control works in Mendix, see [Version Control](/refguide/version-control/).

[TBD]
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Automatic Fetching"
title: "Enabling Automatic Fetching"
url: /refguide/auto-fetch/
weight: 20
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Clone Type"
title: "Selecting the Clone Type"
url: /refguide/clone-type/
weight: 40
description: Describes full and partial clone types for Git.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Git Storage Optimization"
title: "Optimizing Git Storage"
url: /refguide/git-storage-optimization-dialog/
weight: 30
#If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: "Working with Git On-Premises Version Control Server"
linktitle: "Git On-Premises Version Control Server"
title: "Optional: Working with Private Git"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This topic has a lot of info about set up and configuration. Consider either splitting it up (enabling / configuring) or moving the whole thing into its own separate top-level topic (where?)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my perspective the Optional: Working with Private Git as child of Configuring Version Control is fine. People will find it here, and having the information bundled is probably preferable over splitting it.

url: /refguide/on-premises-git/
weight: 60
weight: 80
description: "Introduces how to work with Git on-premises version control server."
aliases:
- /howto/collaboration-requirements-management/on-premises-git-howto/
Expand Down
Loading