Chloroxite / DoomSquad

A Cooperative Doom mod designed primarily for Zandronum.
1 stars 0 forks source link

Remove compiled ACS #1

Open pgsocks opened 1 year ago

pgsocks commented 1 year ago

Build artifacts like these compiled ACS files shouldn't be added to a code repo. Instructions for generating them should be on the README instead.

Chloroxite commented 1 year ago

Is there a specific reason to do this? I just have it like this so it's easier to set up a usable zip/pk3 file from the repo for those that want the very latest version.

pgsocks commented 1 year ago

It's good practice to avoid putting generated code or build artifacts in your repo, because they could get out of sync from their source if the maintainer forgets to regenerate them before committing changes. A change of tools could also produce or expect different binaries even if the code hasn't changed. One more issue that's not much of a concern here is that Git doesn't store binary blobs efficiently, so you should avoid source controlling blobs that change frequently, but these aren't big enough to matter.

pgsocks commented 1 year ago

You could probably use GitHub Actions to compile the ACS and package the pk3 automatically every time changes are pushed. I'll make a pull request for that if I have time.

Chloroxite commented 1 year ago

Good to know, however I think it's worth noting that when I'm working on this mod, I kinda have to recompile the ACS literally every time I go to test it (which I do very often). I don't generally make changes to the ACS without testing them as well, which requires compiling them. I will consider this next time I get the urge to work on this mod, but who knows when that will be. I'll even write it down in my "TODO" list so I don't forgor.

Chloroxite commented 1 year ago

I am also not sure there's more than one way to compile ACS, that being with the ACC compiler