Have you ever faced any issues with
git clone? Personally, I can’t recall any significant or memorable problems I’ve encountered while cloning remote repositories. Typically, the issues were related to authentication or network connectivity. Therefore, there was nothing particularly special to write about. However, as you work with different environments, the chances of coming across something interesting enough to share increase, even though it might be obvious to some.
Let’s take a simple example: you’re trying to clone an existing repository, which was created by someone else. The repository had already been filled out with files you need. Assuming you have credentials in place, you run git clone <repo’s url> on your Windows machine and get the following:
What could go wrong? The cloning process succeeded, indicating that the issue is not related to Git credentials or network connectivity. However, the checkout process failed. What does this mean? It means that if you navigate to the folder of the cloned repository in the explorer, you won’t find any files written to the disk. Now, let me reveal the full error message, which is straightforward:
error: invalid path 'config/app1/application-staging.yml ' fatal: unable to checkout working tree
Found a “root cause”? There is the whitespace at the end of the filename.
However, you may wonder, since the repository was pre-created and used by other people, how did this happen? You’re correct to question that.
The reason is that Windows doesn’t support trailing space characters and automatically removes them when saving a file (you can read more about it here). On the other hand, Linux does support both leading and trailing whitespaces in filenames.
Git knows about these limitations and has a special config setting to control it:
If set to true, do not allow checkout of paths that would cause problems with the NTFS filesystem, e.g. conflict with 8.3 “short” names. Defaults to
trueon Windows, and
The reason why other people can clone the repo without issues is that core.protectNTFS is set to false (manually or because of underlying OS)
So, to clone the repo on Windows you can use the following command:
get clone -c core.protectNTFS=false <repo url>
As a summary, I would advise all developers and DevOps engineers to strictly avoid using trailing or leading spaces in filenames altogether. By doing so, we can eliminate the potential conflicts and issues that may arise from incompatible behaviors between different operating systems.