refactor(vcs): VCS configuration to support common and custom attributes #9271
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9271 +/- ##
=========================================
Coverage 67.49% 67.49%
Complexity 1198 1198
=========================================
Files 241 241
Lines 8495 8495
Branches 900 900
=========================================
Hits 5734 5734
Misses 2399 2399
Partials 362 362
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
wkl3nk
force-pushed
the
wkl3nk/make-vcs-plugins-configurable
branch
5 times, most recently
from
60b8d10
to
ae31656
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
wkl3nk
force-pushed
the
wkl3nk/make-vcs-plugins-configurable
branch
5 times, most recently
from
1cf9421
to
ce5d30c
Compare
|
I believe the options for configuring submodule recursion could be injected via package curations. Have you considered this? |
|
@fviernau Hello, can you explain a little bit more please? |
I believe it makes sense to have the ability to configure this separate per dependency.
|
| @@ -387,7 +388,8 @@ abstract class VersionControlSystem( | |||
| workingTree: WorkingTree, | |||
| revision: String, | |||
| path: String = "", | |||
| recursive: Boolean = false | |||
| recursive: Boolean = false, | |||
| options: Options = emptyMap() // VCS-specific options only | |||
There was a problem hiding this comment.
Just adding an unused option to the function signature does not fix anything, so you should not say so in the commit message. Most importantly, these options are not read from the configuration file and passed on.
There was a problem hiding this comment.
I hope I have improved the commit message now, also emphasising that this options are only available if the VCS plugin is consumed using the API.
There was a problem hiding this comment.
options are only available if the VCS plugin is consumed using the API.
I fear that's not enough. For the PR to be acceptable, VCS plugins should be configurable via config.yml entries, just like package managers like GradleInspector, independently of any programmatic use / ORT Server context.
While VCS implementations are already plugins, they are not yet configurable. VCS implementations require common configurations (e.g., `revision`, `recursive`) and should support also VCS-specific configurations if they are consumed via their API. This allows to add functionality to individual VCS implementations without the need to implement them for all of them. This refactoring keeps the common configurations attributes as they are, while VCS-specific configurations are stored generically in an `options` attribute. Fixes oss-review-toolkit#8556. Signed-off-by: Wolfgang Klenk <[email protected]>
For large repositories with many layers of nested Git submodules, the download process can be very time-consuming and often results in duplicate projects in the tree of nested submodules. This feature introduces configuration options to limit the recursive checkout of nested Git submodules to the first layer, optimizing performance and reducing redundancy. Additionally, it also allows to limit the depth of commit history to fetch when downloading the projects. Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk
force-pushed
the
wkl3nk/make-vcs-plugins-configurable
branch
from
ce5d30c
to
d9ef04f
Compare
While VCS implementations are already plugins, they are not yet configurable. VCS implementations require common configurations (e.g.,
revision,recursive) and should support also VCS-specific configurations if they are consumed via their API.This allows to add functionality to individual VCS implementations without the need to implement them for all of them.
This refactoring keeps the common configuration attributes as they are, while VCS-specific configurations are stored generically in an
optionsattribute.The change also adds VCS-specific configuration options for Git: The strategy for checking out repositories with submodules now allows to only check out the first layer of submodules.
For more details, please have a look at the respective commits.
Fixes #8556.