Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make VCS plugins configurable #8556

Open
2 tasks
sschuberth opened this issue Apr 23, 2024 · 0 comments · May be fixed by #9271
Open
2 tasks

Make VCS plugins configurable #8556

sschuberth opened this issue Apr 23, 2024 · 0 comments · May be fixed by #9271
Labels
downloader About the downloader tool enhancement Issues that are considered to be enhancements plugin Topics related to ORT plugins

Comments

@sschuberth
Copy link
Member

While VCS implementations already are plugins, they are not configurable yet. As VCS both require configs that are common to all VCS implementations, e.g.

ort/downloader/src/main/kotlin/VersionControlSystem.kt

Lines 166 to 169 in d53ac0b

/**
* The priority in which this VCS should be probed. A higher value means a higher priority.
*/
protected open val priority: Int = 0

but should also be able to get implementation-specific configuration, probably an approach like with PackageManagerConfiguration would be feasible.

Having such configuration would probably help to address the following related issues

Tasks
Beta Give feedback
  1. Make recursive cloning (e.g. of Git submodules) configurable #6697
    configuration downloader enhancement scanner
  2. Configurable URL replacements for the analyzer / downloader #6698
    analyzer configuration downloader enhancement
@sschuberth sschuberth added enhancement Issues that are considered to be enhancements downloader About the downloader tool plugin Topics related to ORT plugins labels Apr 23, 2024
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 10, 2024
@wkl3nk
refactor(vcs): VCS configuration to support common and custom attributes
1e98fd4 
While VCS implementations are already plugins, they are not yet
configurable. VCS implementations require common configurations
(e.g., revision, recursive) and should support implementation-specific
configurations that are unique to each VCS.

This refactoring encapsulates common configurations as attributes of a
`VersionControlSystemConfiguration` data class, while implementation-specific
configurations are stored generically in an `options` attribute.

Fixes oss-review-toolkit#8556

Signed-off-by: Wolfgang Klenk <[email protected]>
@wkl3nk wkl3nk linked a pull request Oct 10, 2024 that will close this issue
Open
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 10, 2024
@wkl3nk
refactor(vcs): VCS configuration to support common and custom attributes
7dddce1 
While VCS implementations are already plugins, they are not yet
configurable. VCS implementations require common configurations
(e.g., `revision`, `recursive`) and should support
implementation-specific configurations that are unique to each VCS.

This refactoring encapsulates common configurations as attributes of a
`VersionControlSystemConfiguration` data class, while implementation-specific
configurations are stored generically in an `options` attribute.

Fixes oss-review-toolkit#8556

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 10, 2024
@wkl3nk
refactor(vcs): VCS configuration to support common and custom attributes
0e432aa 
While VCS implementations are already plugins, they are not yet
configurable. VCS implementations require common configurations
(e.g., `revision`, `recursive`) and should support
implementation-specific configurations that are unique to each VCS.

This refactoring encapsulates common configurations as attributes of a
`VersionControlSystemConfiguration` data class, while
implementation-specific configurations are stored generically in an
`options` attribute.

Fixes oss-review-toolkit#8556

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 11, 2024
@wkl3nk
refactor(vcs): VCS configuration to support common and custom attributes
82ad521 
While VCS implementations are already plugins, they are not yet
configurable. VCS implementations require common configurations
(e.g., `revision`, `recursive`) and should support
implementation-specific configurations that are unique to each VCS.

This refactoring encapsulates common configurations as attributes of a
`VersionControlSystemConfiguration` data class, while implementation-specific
configurations are stored generically in an `options` attribute.

Fixes oss-review-toolkit#8556

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 11, 2024
@wkl3nk
refactor(vcs): VCS configuration to support common and custom attributes
60b8d10 
 While VCS implementations are already plugins, they are not yet
 configurable. VCS implementations require common configurations
 (e.g., `revision`, `recursive`) and should support
 implementation-specific configurations that are unique to each VCS.

 This refactoring encapsulates common configurations as attributes of a
 `VersionControlSystemConfiguration` data class, while
 implementation-specific configurations are stored generically in an
 `options` attribute.

Fixes oss-review-toolkit#8556

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 11, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
4ea0232 
 While VCS implementations are already plugins, they are not yet
 configurable. VCS implementations require common configurations
 (e.g., `revision`, `recursive`) and should support
 implementation-specific configurations that are unique to each VCS.

 This refactoring encapsulates common configurations as attributes of a
 `VersionControlSystemConfiguration` data class, while
 implementation-specific configurations are stored generically in an
 `options` attribute.

Fixes oss-review-toolkit#8556

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 21, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
6534363 
 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.

 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 21, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
bd02471 
 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.

 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 22, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
e2d3b68 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 23, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
3fc74d8 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 23, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
07802ad 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 23, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
101f0fc 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Oct 29, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
4ff4b4c 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 4, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
71da913 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 4, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
39ac3ec 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 7, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
d905615 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 7, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
b158c84 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 8, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
d1036f8 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 8, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
a808b83 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 8, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
a321387 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 11, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
9370898 
 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]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 11, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
307fa1a 
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.

Fixes oss-review-toolkit#8556.

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 11, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
04c00b5 
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.

Fixes oss-review-toolkit#8556.

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 13, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
f8e6bb6 
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.

Fixes oss-review-toolkit#8556.

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 13, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
df4a6fa 
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.

Fixes oss-review-toolkit#8556.

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 13, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
baca8ab 
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.

Fixes oss-review-toolkit#8556.

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 13, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
76d9eb6 
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.

Fixes oss-review-toolkit#8556.

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 21, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
7e1ab88 
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.

The effects are limited to usage through the command-line interface of the Downloader tool, designed primarily for scripted operations. In other stages of the ORT pipeline these configuration options have no effect.

Fixes oss-review-toolkit#8556.

Signed-off-by: Wolfgang Klenk <[email protected]>
wkl3nk added a commit to boschglobal/oss-review-toolkit that referenced this issue Nov 21, 2024
@wkl3nk
refactor(vcs): Enable to provide VCS-specific configuration options
d352301 
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.

The effects are limited to usage through the command-line interface
of the Downloader tool, designed primarily for scripted operations.
In other stages of the ORT pipeline these configuration options
have no effect.

Fixes oss-review-toolkit#8556.

Signed-off-by: Wolfgang Klenk <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
downloader About the downloader tool enhancement Issues that are considered to be enhancements plugin Topics related to ORT plugins
Projects
None yet
Milestone
No milestone
1 participant
@sschuberth