Troubleshooting Version Control

Last modified: November 15, 2024

Introduction

Mendix Studio Pro contains a version control system that supports collaborating with team members. This document describes issues and limitations with Git version control and their workarounds.

For more information and general help on version control, see the following documents:

Troubleshooting

Getting an Unexpected Error: The project contains changes that have not been committed yet. Please commit first before attempting to merge again.

You may get the error The project contains changes that have not been committed yet. Please commit first before attempting to merge again. when you feel there are no uncommitted changes.

This happens due to line endings in CSS files not being handled properly. Thus, sometimes after reverting all changes or applying other version control operations, the css.map files show up in the Changes on Disk dialog box. To prevent the css.map being flagged as changed you can perform the following workaround:

  1. Create a .gitattributes file in the \theme-cache folder of your application (if you have a Windows machine, make sure that a .txt extension is not applied by default).
  2. Add the following content to the file: * text eol=lf
  3. Save the file, and commit and push your changes.

From now on, Git will store the files with the correct line endings and this will not be seen as a change.

Proxy Servers Are Not Supported

Studio Pro communicates with Git repositories by two means: the LibGit2 library and the Git command line interface (Git CLI). LibGit2 provides a nice and clean repository object model that is in intensive use during local repository operations. However, it is not performant enough when it comes to communication with remote Git servers. This is when the Git CLI is used and Studio Pro switches to this client while performing fetch, pull, and push operations (that is why the Git for Windows package, which ships Git CLI to your computer, is an integral part of the Studio Pro installation). Therefore, any operation that requires transferring data to or from remote Git repositories, uses the Git CLI client.

Unfortunately, Git for Windows is not synchronized with the system proxy settings by default, which means it may be tricky to integrate it into Studio Pro seamlessly. We are trying our best to provide integration as soon as possible but, as a workaround, you can configure the proxy settings directly by either overriding http_proxy, https_proxy, and all_proxy (for more information, see the Git documentation), or by setting the proxy URL in your local .git/config using the following commands:

  • Configure the proxy settings:

    git config --local http.proxy [protocol://][user[:password]@]proxyhost[:port]

  • Check that the setting has changed:

    git config --local http.proxy

You can also use the --global modifier to apply the changes system-wise, but this is not recommended if you are using Git for things other than Mendix development.

Getting an Oops Pop-Up Menu

You may get an Oops pop-up menu when setting a name and an email for Git in the Preferences dialog box or while committing. This problem might occur if there is no global Git config file on the PC yet. To fix this issue, you can use the Git command line client and do the following:

  • Specify the user name: git config --global user.name "<Name>"
  • Specify the email: git config --global user.email "<Email>"

Any of these commands will create a global Git config. Subsequent interactions via the Studio Pro interface will succeed from now on.

Merging Branches Results in No Changes Being Applied

When two branches are merged, changes sometimes do not come through. To fix this issue, take the following steps:

  1. Ensure user.name and user.email exist in your git config:
    • Specify the user name: git config --global user.name "<Name>"
    • Specify the email: git config --global user.email "<Email>"
  2. Ensure the git version on your machine is 2.43.x or above:
    • Check your installed git version by running the following command: git version.
    • If needed, install the correct version from the git website.

Connection Problems When Cloning the Git Repository

If you face connection problems when cloning the Git repository using the Open App or Download App dialog box, the first thing to check is whether the URL of the remote Git repository is correct. It should not be copied from the browser address bar. Most Git services have a noticeable colored Clone button which provides the correct URL in a pop-up window. You should use this URL with Studio Pro.

Reporting Issues

For the Studio Pro developers to be able to troubleshoot any issues that you face with beta Git support, Studio Pro provides a logging mechanism.

When filing a Git support issue with Mendix Support, attach the log files by doing the following:

  1. Navigate to the Help menu > Open Log File Directory:

    Download from Version Control Server dialog

  2. Copy the file called log.txt into your ticket. You can also attach additional log.X.txt files if they exist.

Git Properties Useful for Troubleshooting

There are properties of the Git repository that provide you with information useful for troubleshooting different issues. Execute the following using the command line in the app’s folder:

git status -b — provides information on the current state of the repository

git remote -v — lists the remotes specified for the repository

git config --list --show-origin --show-scope — provides information on user’s Git config

Cannot Create Package from a Revision

Sometimes it is impossible to create a package from a certain revision. See below for a description of the most common case and troubleshooting steps for resolving it.

Missing Metadata

Issue

When you commit (and push) changes to the repository, Studio Pro adds an additional commit with so called metadata to a special refspec .git/refs/notes/mx_metadata. Making it a refspec means that you will not see this commit in your commits history. This metadata contains the information needed to create a deployment package (for instance the version of Studio Pro that was used to create this revision).

To create a deployment package, Studio Pro downloads the specific revision into a temporary folder and then creates the package from there. Studio Pro checks the Mendix version of the selected revision to confirm that it is compatible with the version of Studio Pro.

Without the metadata, Studio Pro cannot find out this information.

Solution

You can force Studio Pro to recreate the metadata by doing the following:

  1. Checkout the revision you want to create a deployment package from in a separate directory.
  2. Open it with the correct version of Studio Pro.
  3. Create a branch from it and switch to the new branch.
  4. Do a cosmetic change (for example, move an activity in a microflow a few pixels)
  5. Commit and Push the changes from Studio Pro.

This will recreate the metadata and you should now be able to create a deployment package from this new revision.

Installed Git Version Does Not Meet Studio Pro’s Requirement

Studio Pro requires a specific minimum version of Git (for more information, see System Requirements). If this version is not installed on your device, Studio Pro will show a message during a start-up indicating that certain features will not be available.

You can download and install a recent version of Git from here.

The Index Is Locked

Sometimes the Git process may crash while performing any operation on the repository. The reason for this can be a dead battery, a blue screen on Windows, or any other unexpected shutdown. As a result, there is a leftover index.lock file, which blocks other Git operations. To fix this, go to <directory of your app>/.git/ and delete the index.lock file.