Remove unnecessary submodules from tools directory #2196
Conversation
Git submodules are intended for bringing in a copy of another repo that is needed for building the project. They are not for general reference to other projects of interest. This commit removes those unneeded submodules, and instead adds a text file listing those repos, with a link to each and a brief description.
|
Windows build seems to be failing currently, due to an unrelated reason. |
| @@ -0,0 +1,49 @@ | |||
| # Other projects related to Jamulus | |||
There was a problem hiding this comment.
Are you sure you want to add this to the main repo? Maybe it would be better to have it as a post in the community KB on the website.
There was a problem hiding this comment.
Maybe. I just didn't want to completely remove information from the repo, so I created this document as somewhere to put it. If we moved it to the web site and removed it from here, people cloning the repo might not know the information is available to be found elsewhere. I don't always find things easy to locate on the website.
There was a problem hiding this comment.
I don't always find things easy to locate on the website.
Some advanced stuff is quite hidden… probably worth re-organising the site?
Personally, I‘d prefer to have documentation on the website, but it’s up to you where to put it.
Asking for another opinion:
@gilgongo should we move this document to the website?
There was a problem hiding this comment.
Might be nice to have it them on the website. Can't immediately think where though - perhaps as page linked out from the client and server manuals?
There was a problem hiding this comment.
I suppose since these projects are a) subject to change out of our control and b) not core core information about Jamulus, then they would be a candidate for the KB, yes.
No difference in the actual execution. It does avoid some unnecessary fetching of submodules in the CI build. It was the failure of one of those fetches recently that prompted me to look at it. |
Git submodules are intended for bringing in a copy of another repo that is needed for building the project. They are not for general reference to other projects of interest.
This commit removes those unneeded submodules, and instead adds a text file listing those repos, with a link to each and a brief description.
Context: Fixes an issue?
The CI build pulls in all submodules, most of which are currently unnecessary and sometimes fail.
Does this change need documentation? What needs to be documented and how?
No documentation needed
Status of this Pull Request
Ready
What is missing until this pull request can be merged?
Discussion and approval.
Checklist