Skip to content
This repository has been archived by the owner on Sep 28, 2021. It is now read-only.

Git submodule makes distribution harder (missing from GitHub ZIP archives) #22

Closed
akien-mga opened this issue May 5, 2020 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@akien-mga
Copy link

akien-mga commented May 5, 2020

Hi,

I was reviewing the inclusion of this SDK in the Godot Asset Library, but I noticed that it uses a Git submodule at addons/enjin/sdk/graphql/templates, which makes distribution more difficult. Particularly, the "Download ZIP" / archive generation feature of GitHub (powered by git-archive) does not include submodules, so archives of this repository lack the necessary templates.

Godot's Asset Library requires on those generated ZIP archives to download assets locally (it doesn't use Git / libgit2 - for now), so the Enjin SDK couldn't be installed as is.

While I think it's a real shame and GitHub should fix this, for the time being I would suggest making a hard copy of your templates in the enjin-godot-sdk repository instead of using a submodule. Submodules are the correct technical solution for such a dependency, but sadly the Git ecosystem doesn't support them as well as it should.

On a side note - https://github.com/enjin/enjin-godot-sdk/blob/master/.gitmodules uses git@github.com:, which requires authentication and is thus only available for people with permissions on this repository. If you were to keep the submodule, it should be changed to https://github.com/ to be available to unprivileged users.


Note: Once this is fixed, the user who submitted https://godotengine.org/asset-library/asset/edit/1968 should be able to edit this pending asset to change the commit hash for the new version. I'll approve it then so that it becomes public.

@Favorlock Favorlock self-assigned this May 6, 2020
@Favorlock Favorlock added the bug Something isn't working label May 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Development

No branches or pull requests

2 participants