Snippet Choice #8257

nnobelis · 2024-02-12T10:12:09Z

This pull request introduces the Snippet Choice feature to ORT.

Please have a look at the documentation in website/docs/configuration/snippet-choice.md.

nnobelis · 2024-02-15T15:32:51Z

According to @mnonnenmacher , this is normal the markdown-links test is failing as the link is pointing to a file that is added in current PR, and not present in main yet. There is no workaround, it can be ignored.

model/src/main/kotlin/config/PackageSnippetChoice.kt

cli/src/funTest/assets/git-repo-expected-output.yml

model/src/main/kotlin/config/PackageSnippetChoice.kt

model/src/main/kotlin/config/RepositoryConfiguration.kt

model/src/main/kotlin/config/SnippetChoice.kt

model/src/main/kotlin/config/SnippetChoiceReason.kt

model/src/test/kotlin/config/RepositoryConfigurationTest.kt

website/docs/configuration/snippet-choice.md

scanner/src/main/kotlin/ScanContext.kt

website/docs/configuration/snippet-choice.md

sschuberth · 2024-02-18T20:41:22Z

website/docs/configuration/snippet-choice.md

@@ -0,0 +1,187 @@
+The snippets are short pieces of code coming from difference public sources such as GitHub, GitLab, Stackoverflow, ...
+
+Some product such as ScanOSS and FossID scrape those public sources and build a Knowledge Base of snippets, classifying


"Some product such as" -> "So-called snippet scanners like"

I wouldn't capitalize "Knowledge Base" or "Author, Version and License" in the next sentence.

Note: I'm pausing review here.

website/docs/configuration/snippet-choice.md

mnonnenmacher · 2024-02-22T17:22:46Z

model/src/main/kotlin/config/SnippetChoices.kt

+/**
+ * The URL of the [RepositoryProvenance] the snippet choice applies to.
+ */
+data class Provenance(val url: String)


Can you give this class another name to avoid a name conflict if some code has to use this and the other Provenance class? I don't have a good idea, maybe TargetProvenance?

Or also move to a snippet sub-package to disambiguate the FQN?

@sschuberth Did you mean to only move or to rename and move? I guess I can live with only moving it like it was done now.

I was meaning to only move.

model/src/main/kotlin/config/snippet/SnippetChoice.kt

model/src/test/kotlin/config/RepositoryConfigurationTest.kt

website/docs/configuration/snippet-choice.md

scanner/src/main/kotlin/ScanContext.kt

mnonnenmacher · 2024-02-23T13:01:20Z

@sschuberth LGTM, do you want to have another look?

I won't have the time to finish the docs revewi soon.

sschuberth · 2024-02-23T13:28:32Z

@sschuberth LGTM, do you want to have another look?

I guess I would probably still have plenty of wording-nits for snippet-choice.md, but I currently do not have time to look at it again thoroughly, so I do not want to block this. I skipped over the code, and from that perspective it looks ok to me now.

mnonnenmacher · 2024-02-23T13:37:01Z

@sschuberth LGTM, do you want to have another look?

I guess I would probably still have plenty of wording-nits for snippet-choice.md, but I currently do not have time to look at it again thoroughly, so I do not want to block this. I skipped over the code, and from that perspective it looks ok to me now.

I think the docs don't have to be perfect from the beginning, we can still improve it later.

mnonnenmacher · 2024-02-23T13:47:53Z

@nnobelis The funTest error is not related to your change, but for the test job you have to fix the RepositoryConfigurationTest.

Signed-off-by: Nicolas Nobelis <[email protected]>

By adding the snippet choices configuration to the scanner context, the snippet scanner implementations such as ScanOSS and FossID can be extended to take into account this configuration. This will be done in a future commit. Signed-off-by: Nicolas Nobelis <[email protected]>

sschuberth · 2024-02-23T17:01:30Z

I now realized model/src/main/kotlin/config/SnippetChoices.kt is not in the snippet package like the rest is. Is this an oversight?

nnobelis force-pushed the nnobelis/snippet_choice_step_1 branch 9 times, most recently from 0e0d89b to 1929262 Compare February 15, 2024 15:07

nnobelis marked this pull request as ready for review February 15, 2024 15:31

nnobelis requested review from a team as code owners February 15, 2024 15:31

sschuberth requested changes Feb 15, 2024

View reviewed changes

nnobelis force-pushed the nnobelis/snippet_choice_step_1 branch 2 times, most recently from ff6b70e to 3d163d9 Compare February 16, 2024 07:10

nnobelis requested a review from sschuberth February 16, 2024 07:30

sschuberth previously requested changes Feb 18, 2024

View reviewed changes

nnobelis force-pushed the nnobelis/snippet_choice_step_1 branch 3 times, most recently from 5ef4693 to a92b14b Compare February 19, 2024 06:36

nnobelis requested a review from sschuberth February 19, 2024 06:38

sschuberth requested a review from a team February 19, 2024 07:34

sschuberth reviewed Feb 19, 2024

View reviewed changes

website/docs/configuration/snippet-choice.md Show resolved Hide resolved

nnobelis force-pushed the nnobelis/snippet_choice_step_1 branch from a92b14b to bfb6cbc Compare February 19, 2024 08:02

nnobelis requested a review from sschuberth February 19, 2024 08:03

mnonnenmacher requested changes Feb 22, 2024

View reviewed changes

nnobelis force-pushed the nnobelis/snippet_choice_step_1 branch from bfb6cbc to d909214 Compare February 23, 2024 07:11

nnobelis requested a review from mnonnenmacher February 23, 2024 07:12

mnonnenmacher previously approved these changes Feb 23, 2024

View reviewed changes

nnobelis added 2 commits February 23, 2024 14:54

feat(RepositoryConfiguration): Add support for snippet choice

e78cae4

Signed-off-by: Nicolas Nobelis <[email protected]>

nnobelis dismissed mnonnenmacher’s stale review via a84d484 February 23, 2024 13:54

nnobelis force-pushed the nnobelis/snippet_choice_step_1 branch from d909214 to a84d484 Compare February 23, 2024 13:54

nnobelis requested a review from mnonnenmacher February 23, 2024 13:54

mnonnenmacher approved these changes Feb 23, 2024

View reviewed changes

mnonnenmacher merged commit 4e0b6a1 into oss-review-toolkit:main Feb 23, 2024
17 of 20 checks passed

mnonnenmacher deleted the nnobelis/snippet_choice_step_1 branch February 23, 2024 15:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Snippet Choice #8257

Snippet Choice #8257

nnobelis commented Feb 12, 2024

nnobelis commented Feb 15, 2024

sschuberth Feb 18, 2024

sschuberth Feb 18, 2024

sschuberth Feb 18, 2024

mnonnenmacher Feb 22, 2024

sschuberth Feb 22, 2024 •

edited

Loading

mnonnenmacher Feb 23, 2024

sschuberth Feb 23, 2024

mnonnenmacher commented Feb 23, 2024

sschuberth commented Feb 23, 2024

mnonnenmacher commented Feb 23, 2024

mnonnenmacher commented Feb 23, 2024

sschuberth commented Feb 23, 2024 •

edited

Loading

		@@ -0,0 +1,187 @@
		The snippets are short pieces of code coming from difference public sources such as GitHub, GitLab, Stackoverflow, ...

		Some product such as ScanOSS and FossID scrape those public sources and build a Knowledge Base of snippets, classifying

Snippet Choice #8257

Snippet Choice #8257

Conversation

nnobelis commented Feb 12, 2024

nnobelis commented Feb 15, 2024

sschuberth Feb 18, 2024

Choose a reason for hiding this comment

sschuberth Feb 18, 2024

Choose a reason for hiding this comment

sschuberth Feb 18, 2024

Choose a reason for hiding this comment

mnonnenmacher Feb 22, 2024

Choose a reason for hiding this comment

sschuberth Feb 22, 2024 • edited Loading

Choose a reason for hiding this comment

mnonnenmacher Feb 23, 2024

Choose a reason for hiding this comment

sschuberth Feb 23, 2024

Choose a reason for hiding this comment

mnonnenmacher commented Feb 23, 2024

sschuberth commented Feb 23, 2024

mnonnenmacher commented Feb 23, 2024

mnonnenmacher commented Feb 23, 2024

sschuberth commented Feb 23, 2024 • edited Loading

sschuberth Feb 22, 2024 •

edited

Loading

sschuberth commented Feb 23, 2024 •

edited

Loading