Set up submodules for common files in all docs repositories #17

Open
opened 2026-03-03 10:58:13 +00:00 by pbokoc · 0 comments
Owner

We've been having a longstanding problem where we update common files like build scripts in the template repo, but we never propagate the change to all published repos because there's way too many of them to do it manually. This leads to repositories sometimes being unable to build and contributors being confused about it.

We should set up each repository with a git submodule that pulls in these common files from a central location; we could probably use the template repo for this, or set up a separate one just for this purpose. Then, we'll need a bot to run git submodule pull once in a while (say, once an hour) to propagate these changes everywhere.

A submodule has to be a separate directory, so we'll need to create symlinks for all these files in their correct locations.

This should also be documented in each repo's readme so people don't try to make changes to the scripts on a per-repo basis.

We've been having a longstanding problem where we update common files like build scripts in the template repo, but we never propagate the change to all published repos because there's way too many of them to do it manually. This leads to repositories sometimes being unable to build and contributors being confused about it. We should set up each repository with a git submodule that pulls in these common files from a central location; we could probably use the template repo for this, or set up a separate one just for this purpose. Then, we'll need a bot to run `git submodule pull` once in a while (say, once an hour) to propagate these changes everywhere. A submodule has to be a separate directory, so we'll need to create symlinks for all these files in their correct locations. This should also be documented in each repo's readme so people don't try to make changes to the scripts on a per-repo basis.
pbokoc self-assigned this 2026-03-03 10:58:13 +00:00
Sign in to join this conversation.
No milestone
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
docs/tickets#17
No description provided.