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.

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

model: Introduce a concludedCopyrights field to package curations #5680

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

sschuberth
Copy link
Member

@sschuberth sschuberth commented Aug 24, 2022

In German law, the author and the copyright holder can be two separate
legal entities and therefore also need to be tracked separately.

Introduce a new field for declared copyrights that is now the primary
source for copyright holder information. Authors are still only used as
copyright holders if the addAuthorsToCopyrights option is enabled.

For now, all package manager implementations set empty declared
copyrights. Filling the declared copyrights is left as a future exercise
(also see 1). Currently, the only way to add declared copyrights is via
curations.

This change resolves #4519.

Signed-off-by: Rainer Bieniek [email protected]
Signed-off-by: Sebastian Schuberth [email protected]

@sschuberth sschuberth changed the title model: Introduce a new copyright holder field to data model model: Introduce a new declared copyright field to the data model Aug 24, 2022
@fviernau
Copy link
Member

@sschuberth why is this a new PR? How does it differ from #5504?

@codecov
Copy link

codecov bot commented Aug 24, 2022

Codecov Report

Base: 57.73% // Head: 57.73% // No change to project coverage 👍

Coverage data is based on head (7c3ee72) compared to base (7c3ee72).
Patch has no changes to coverable lines.

❗ Current head 7c3ee72 differs from pull request most recent head 85f99a1. Consider uploading reports for the commit 85f99a1 to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##               main    #5680   +/-   ##
=========================================
  Coverage     57.73%   57.73%           
  Complexity     2187     2187           
=========================================
  Files           321      321           
  Lines         18987    18987           
  Branches       3730     3730           
=========================================
  Hits          10963    10963           
  Misses         6885     6885           
  Partials       1139     1139           
Flag Coverage Δ
funTest-analyzer-docker 74.55% <0.00%> (ø)
funTest-non-analyzer 46.21% <0.00%> (ø)
test 27.53% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@sschuberth sschuberth changed the title model: Introduce a new declared copyright field to the data model model: Introduce a new declared copyrights field to data model Aug 24, 2022
@sschuberth
Copy link
Member Author

@sschuberth why is this a new PR? How does it differ from #5504?

As I'm taking over @porsche-rbieniek's PRs it's more convenient for me to work on my own branches than his. I'll document the differences once this moves out of draft state.

@sschuberth sschuberth changed the title model: Introduce a new declared copyrights field to data model Introduce a new concludedCopyrights field to the data model Sep 21, 2022
The feature was a crude way to curate copyright statements by curating
authors and enabling the addition of authors as copyrights (with a
missing year even). That appraoch does not work if authors and copyrights
need to stay separate, as e.g. by German law not every author is a
copyright holder.

So remove this feature in favor of an upcoming change that introduces
proper and dedicated curations for concluded copyright statements.

Signed-off-by: Sebastian Schuberth <[email protected]>
Similar to the `concludedLicense` field, introduce a `concludedCopyrights`
field that is to be set exclusively via a package curation [1] to
override any detected copyright statements. Note that there is no such
thing as *declared* copyright statements because package managers do not
support them explicitly [1].

The concluded copyrights will get associated to all effective licenses;
there currently is no way to curate a copyright statement for a specific
license only. Behavior-wise this is no change compared to previous
feature of curating authors and enabling the `addAuthorsToCopyrights`
option.

As a bonus, this fixes a subtle bug where previously packages might have
been skipped in the scan if `authors` were set but
`addAuthorsToCopyrights` was disabled.

Resolves #4519.

[1]: #5504 (comment)
[1]: https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-curations-yml.md

Signed-off-by: Rainer Bieniek <[email protected]>
Signed-off-by: Sebastian Schuberth <[email protected]>
@sschuberth sschuberth changed the title Introduce a new concludedCopyrights field to the data model model: Introduce a concludedCopyrights field to package curations Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow to curate copyrights directly (not via authors)
3 participants