-
Notifications
You must be signed in to change notification settings - Fork 20
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
Delete outdated notice #13
Delete outdated notice #13
Conversation
@erikbosch can you test/check if/how that affects release workflow and maybe give me pointers howto fix? |
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #13 +/- ##
==========================================
+ Coverage 48.61% 48.74% +0.12%
==========================================
Files 31 31
Lines 10879 10839 -40
==========================================
- Hits 5289 5283 -6
+ Misses 5590 5556 -34 ☔ View full report in Codecov by Sentry. |
If we are to remove But I am not sure if we "just" shall delete it. First, many of our license headers as of today refer to the NOTICE file like this: https://github.com/eclipse-kuksa/kuksa-databroker/blob/main/databroker/src/broker.rs
If using our style of copyright line it seems to be recommended practice to have a NOTICE file, see https://www.eclipse.org/projects/handbook/#ip-copyright-headers. For kuksa-incubation we have a NOTICE as well, but without third party info. So should we note have a notice file and include it in the release as long as we refer to it from license headers, as it says "See the NOTICE file(s) distributed with this work". If it is OK to remove the NOTICE file, is it then a need to keep the reference in the license header? The Eclipse recommendations on Notice file seem to be quite rigid and possibly outdated if a project auto-generate SBOMs. A pragamatic way if we decide to keep the NOTICE file could possibly be to instead of stating third party licenses explain where to find that info, i.e. explain how/where you can find the data for a specific release, latest main or your specific build. We should better come up with "our preferred way" and then try to align that in all eclipse-kuksa repos |
3a80326
to
cdd6bd6
Compare
Didn't want to change all headers (and potentially violate the requirment/recommendation to have a NOTICE file). I liked the KUKSA incubation version and adapted it. May understanding would be, the only time we declare Third party licenses in a NOTICE.m would be if we copy some code of other projects INTO this repository (i.e. take some MIT code form somewhere, check it in, potentially even adding Apache license), in that case we would need to reference this. For dependencies during the build process a static notice is impossible. I added a general segment explaining about dependencies. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor spelling errors that we better shall fix before merging, but in general looking good
Signed-off-by: Sebastian Schildt <[email protected]>
cdd6bd6
to
7d22afc
Compare
Done, still needs a "fresh" approve |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
NOTICE is outdated and not used anymore
(all required dependencies are seen up-to-date in package manager files, and exact transitive dependencies depend on the build environment, and as such can not be documented in code anyway. For our release artifacts we DO generate sboms, and add them to the artifacts where they belong)