gitignore icon indicating copy to clipboard operation
gitignore copied to clipboard

Fix Unreal Engine plugin binaries on subfolders

Open maximetinu opened this issue 4 years ago • 6 comments

Reasons for making this change:

When I installed the Rider plugin for UE5, I noticed that some subfolders with binaries were not being git ignored

Links to documentation supporting these rule changes:

This is the project with which I noticed the issue

https://github.com/Maximetinu/batterycollector-ue5

This is the commit I made to fix it

https://github.com/Maximetinu/batterycollector-ue5/commit/71dad496dd7a15c53103fb2a95be7442bf438feb

I've slightly modified the rule for this PR to make it more specific to this case

Steps to reproduce

  • Pull down that repository prior to the commit I made to fix it
  • Open the project with UE5, enable Rider plugin on the project and open the IDE to see the issue happening

maximetinu avatar Oct 16 '21 19:10 maximetinu

I'm participating in hacktoberfest, so if you can add the hacktoberfest-accepted label to the PR, I'll appreaciate it 😄

maximetinu avatar Oct 16 '21 19:10 maximetinu

Unfortunately, we could not make this an Hacktoberfest contribution.

Can you clarify this is an issue happening to other UE5/Rider users?

bdougie avatar Dec 10 '21 21:12 bdougie

Hi

Yes, other users must also be encountering this.

The original ignore rule is, for example, Plugins//Binaries/. The single * between Plugins and Binaries only contemplates one level of subfolders.

The issue was that the Rider plugin doesn't output its binaries directly to Plugins/Rider/Binaries/, like the original rule assumed. It had the binaries on a deeper subfolder, Plugins/Developer/RiderLink/Binaries/ which was not being git ignored

So I changed the rule to ignore any Intermediate/ and Binaries/ folder, doesn't matter it's depth in the folder hierarchy.

For example, these are the changes that Git detects when I open Rider with the original .gitignore:

image

As you can see, that Plugins/Developers/RiderLink/Binaries/ were not being .gitignored by Plugins//Binaries/. Hence my change to make it just Binaries/

Another valid alternative would have been Plugins/**/Binaries/*. If you prefer a more explicit one like that, we can also change it.

maximetinu avatar Dec 12 '21 14:12 maximetinu

Also having issues with RiderLink and other plugins binary files not being ignored. Is there any reason why it isn't merged yet?

image

salmonslay avatar Apr 14 '23 09:04 salmonslay

I'd merge it if I had the rights!

maximetinu avatar Apr 14 '23 23:04 maximetinu

Bump. This change will only cause good. I've closed my dupe #4213

jackfranzen avatar Aug 04 '23 21:08 jackfranzen