refactor(Repository): Add RepositoryProvenance attribute
#10575
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `Repository` data structure seems the easiest place to allow `Provenance`s as `Analyzer` and `Scanner` input. This avoids refactoring the attributes of higher level data structures, such as `OrtResult`. At the momemnt the implementation limits it to `RepositoryProvence` though, in order to keep its previous behavior. To that end, it also continues to expose the raw `VcsInfo` of the `provenance` as its `vcs` attribute. Signed-off-by: Jens Keim <[email protected]>
fviernau
requested changes
Jul 9, 2025
| /** | ||
| * Original VCS-related information from the working tree containing the analyzer root. | ||
| */ | ||
| val vcs: VcsInfo, | ||
| val vcs: VcsInfo = provenance.vcsInfo, |
There was a problem hiding this comment.
Can you help me understand what value the val provenance: RepositoryProvenance as it always contains a VcsInfo. So, we have same information as before.
Also, what's the reason for keeping the vcs attribute?
There was a problem hiding this comment.
This would be only the first step towards allowing more than just VcsInfo as the provenance of a Repository.
Right now it is limited to RepositoryProvenance in order to not break previous behavior. Same goes for keeping the vcs attribute.
If this scope is too small, I can always add to this draft first.
There was a problem hiding this comment.
I added some more context to PR description.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This draft includes the first changes for my personal POC for the
LocalProvenanceInput discussed in #8803.As it's scope is so small, it might be good first contribution towards that goal.
If not, feel free to let me know. All feedback is welcome.
The
Repositorydata structure seems the easiest place to allowProvenances asAnalyzerandScannerinput.This avoids refactoring the attributes of higher level data structures, such as
OrtResult.At the moment the implementation limits it to
RepositoryProvencethough, in order to keep its previous behavior. To that end, it also continues to expose the rawVcsInfoof theprovenanceas itsvcsattribute.Signed-off-by: Jens Keim [email protected]