Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.91 KB

plain-text-templates.md

File metadata and controls

40 lines (30 loc) · 1.91 KB

Notice Templates

The PlainTextTemplateReporter enables customization of the generated open source notices with Apache Freemarker templates and producing any other arbitrary plain text files, such as .adoc files.

ORT provides two templates that can be used as a base for creating your custom open source notices:

  • default: Prints a summary of all licenses found in the project itself and lists licenses for all dependencies separately.
  • summary: Prints a summary of all licenses found in the project itself and all dependencies.

See the code comments in the templates for how they work.

Command Line

To use one or both of the provided templates pass the template.ids to the PlainTextTemplate reporter_

cli/build/install/ort/bin/ort report
  -i [evaluator-output-path]/evaluation-result.yml
  -o [reporter-output-path]
  --report-formats PlainTextTemplate,StaticHtml,WebApp
  -O PlainTextTemplate=template.id=NOTICE_DEFAULT,NOTICE_SUMMARY

To use one or more custom templates pass the template.paths to the PlainTextTemplate reporter. The filename of the template is used as the output filename with the .ftl suffix removed. For example, the following command would produce a .md and an .adoc:

cli/build/install/ort/bin/ort report
  -i [evaluator-output-path]/evaluation-result.yml
  -o [reporter-output-path]
  --report-formats PlainTextTemplate,StaticHtml,WebApp
  -O PlainTextTemplate=template.path=[ort-configuration-path]/custom1.md.ftl,[ort-configuration-path]/custom2.adoc.ftl

The template.id and template.path options can be combined to generate multiple notice files.