Is there a suggested .gitignore to use with UIPath Studio?

I’m working on implementing GIT integeration with Team Foundation Server and noticed that it seems a number of files are constantly changing that don’t seem to have anything to do with the actual code. I suspect that there are files that should be excluded from the repository but I’m not sure all of the details. Does anyone have or know of a suggested .gitignore to use?

Thanks in advance!

3 Likes

@tristaanogre
have a look here:

Not exactly helpful. I know what a .gitignore file is and what it does. What I don’t know is if there is a recommended .gitignore to use with UIPath.

As you can read in the referenced post, the member was looking for this, did IT used and IT was working.

Hoping for some visibility on this post, I have actually been wondering this for some time as well. As an example, simply opening a project results on all these “changes” in the screenshot below appear, sometimes more or less.
When running on debug mode I also notice settings configuration files appearing.

As annoying as the dependencies file updating when I open, of course would not be safe to ignore this. The second one nuget.props updates the machine name and hash code I believe. Unsure if safe to ignore, anyone know?

image

Again… that’s not the question. I know it works… but what should be included? How should it be formatted? Is there a sample .gitignore to use?

2 Likes

Ok. Thanks for your feedback

Hi @tristaanogre I have tried a fair bit of stuff now, and finally settled in this gitignore file for our team, at least for the time being. This .local folder causes a lot of trouble when collaborating with team members, so we deleted it from git as we had some commits causing issues. Once purged and properly ignored, it stops detecting a change when simply opening the project. Additionally, check out the git ignore file suggested by the Enhanced REF, although I see no added value to my daily use. My version ignores where the packages are cached location, which is different for every machine of course.

*PackageCache.json
*ProjectSettings.json
*.cache
*.props
*.backup
*AllDependencies.json
1 Like

Thanks, efluerent. Currently, I have the .local and .settings folders, both, set in my .gitignore and that seems to be doing what I want.

1 Like

Thanks for the solution ! :slight_smile:

However, it would be great if it was existing a suggested .gitignore as reference to use with UiPath Studio!

1 Like

Coming back to contribute an improved version that ignores the objects folder that came with UI Automation Package that just came out. This new version of gitignore also takes care of what I previously stated, it just does it in a cleaner fashion :slight_smile:

I can only attach a ZIP version, but below is the text for reference as well
git ignore.zip (147 Bytes)

.settings/
.local/
.objects/
2 Likes

there’s also a pending commit to the github-templates of gitignores.
feel free to contribute there or even better if you an, merge the pending request.

@efleurent, I’d be careful with the ‘.objects/’ line as this appears to be part of the new UI/Object browser functionality in UiPath Studio. From what I can tell, it tracks the usage of applications and screens from the ‘UI Objects browser’ within your project. You can add some applications/screens and see how items are added within the .objects folder in the project path.

The ‘.settings/’ line is also something to be cautious with if working with more than a single developer. It is best if the team/developers run the same (or at least similar) debug settings and definitely the same production settings. This folder stores the global project configuration settings for defaults when running in debug or run mode.

However, including .local is great, that’s where I’ve seen the most merge conflicts so good idea to include it. :slight_smile:

UI Objects Browser screenshot for referece: