Skip to content

feat(text-templates): Add third-party-notices template#450

Open
tsteenbe wants to merge 1 commit into
mainfrom
tsteenbe/add-third-party-notices-text-template
Open

feat(text-templates): Add third-party-notices template#450
tsteenbe wants to merge 1 commit into
mainfrom
tsteenbe/add-third-party-notices-text-template

Conversation

@tsteenbe

@tsteenbe tsteenbe commented Jul 9, 2026

Copy link
Copy Markdown
Member

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.

Signed-off-by: Thomas Steenbergen <opensource@steenbe.nl>
@tsteenbe tsteenbe requested a review from a team as a code owner July 9, 2026 04:58

@sschuberth sschuberth left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>)

@sschuberth sschuberth Jul 9, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this 2020? Wasn't this written from scratch?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sschuberth It's contains bits of NOTICE_BY_PACKAGE code which is why I choose to keep 2020 copyrights.

@sschuberth sschuberth requested a review from a team July 9, 2026 16:56
@tsteenbe

Copy link
Copy Markdown
Member Author

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.

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.

@sschuberth

Copy link
Copy Markdown
Member

The FTL files in ORT are for me only for testing

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.

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.

2 participants