feat(text-templates): Add third-party-notices template#450
Conversation
Signed-off-by: Thomas Steenbergen <opensource@steenbe.nl>
sschuberth
left a comment
There was a problem hiding this comment.
As a general remark, it slipped my mind that we now have a "text-templates" directory that also contains a "NOTICE_SUMMARY.ftl" like the one we have here. I believe we should make clearer to users which one to prefer by only using either location.
| @@ -0,0 +1,233 @@ | |||
| [#-- | |||
| Copyright (C) 2020 The ORT Project Authors (see <https://github.com/oss-review-toolkit/ort-config/blob/main/NOTICE>) | |||
There was a problem hiding this comment.
Why is this 2020? Wasn't this written from scratch?
There was a problem hiding this comment.
@sschuberth It's contains bits of NOTICE_BY_PACKAGE code which is why I choose to keep 2020 copyrights.
The FTL files in ORT are for me only for testing - the ones users should use as reference are in ort-config. Have some follow up PRs coming to ort and ort-config after which I think it will become much clearer for users - includes rewrite of docs, more config files including FTL files. |
That's new to me. If we'd want these to be only for testing, they should be test resources instead of main resources, and we'd not need the mechanism to specify templates by resources ID. |
New template to help user more easily create the notices that they want/their org is asking from to see output see
THIRD-PARTY-NOTICES.txt
This PR introduces a new template to help users create third-party notices more easily, based ob common requirements learned from various organizations in ORT's community.
Example Output
To see example output from the template, see THIRD-PARTY-NOTICES.txt
Testing
To test this new template, download and extract the test project in notices-generation-test-project.zip and follow instructions in README.md.