RFC: core-lib-repo

[applejag]

Proposed location to place utility code, such as loading config values or
serving version endpoints, so that our other repositories can take use of it.

Rendered: https://github.com/iver-wharf/rfcs/blob/90fdcad/_published/0004-core-lib-repo.md

[fredx30]

My gut feeling when downloading the repos was that this could use a master repo that defines the others as subrepos. This could potentially allow for a recursive clone of the master repo as well as providing an outer path where shared resources could be stored. Another such resource that comes to mind is the docker-compose repo/file.
Edit: See ref here https://git-scm.com/book/it/v2/Git-Tools-Submodules

[Pikabanga]

+1 for creating a wharf-core repo

[applejag]

@fredx30
My gut feeling when downloading the repos was that this could use a master repo that defines the others as subrepos. This could potentially allow for a recursive clone of the master repo as well as providing an outer path where shared resources could be stored. Another such resource that comes to mind is the docker-compose repo/file.
Edit: See ref here https://git-scm.com/book/it/v2/Git-Tools-Submodules

Submodules is a fine thought. What you're proposing is a switch in how we work with the repos locally, where each local repo is a submodule of the "main" repo, if I understand you correctly.

Pros:

• Only 1 repo to clone, instead of 6 distinct. Simpler onboarding procedure, although that is just a one-time thing each developer has to do and we do have it documented by now.
• 1 fewer repos, given that we put the core lib in this "main" repo
• No need to symlink the docker-compose.yml file to outside of the repo it's living in

Cons:

• We have to make sure the main repo is up to date all of the time with its submodule references
• Prone to confusion as we're versioning all the repos separately while the main repo that includes all the other repos has its own version of only the utility code inside itself.

Given these pros and cons, I personally would rather see the wharf-docker-compose repo have submodules and have some automatic script/GitHub action that updates its submodules whenever there's an update, instead of mixing this with the core/utility lib repo.

[applejag]

I'm finalizing the name as wharf-core