Update remaining jinja docs (#2838)

* Add new command

* Update remaining jinja templates and references to use scriban
This commit is contained in:
Teo Voinea
2023-02-15 13:25:40 -05:00
committed by GitHub
parent e9f5a6a2e7
commit 08bb0ec355

View File

@ -3,7 +3,7 @@
OneFuzz can create or update [Github Issues](https://guides.github.com/features/issues/) OneFuzz can create or update [Github Issues](https://guides.github.com/features/issues/)
upon creation of crash reports in OneFuzz managed [containers](../containers.md). upon creation of crash reports in OneFuzz managed [containers](../containers.md).
Nearly every field can be customized using [jinja2](https://jinja.palletsprojects.com/) Nearly every field can be customized using [scriban](https://github.com/scriban/scriban)
templates. There are multiple python objects provided via the template engine that templates. There are multiple python objects provided via the template engine that
can be used such that any arbitrary component can be used to flesh out the configuration: can be used such that any arbitrary component can be used to flesh out the configuration:
@ -43,7 +43,7 @@ There are additional values that can be used in any template:
"organization": "contoso", "organization": "contoso",
"repository": "sample-project", "repository": "sample-project",
"title": "{{ report.executable }} - {{report.crash_site}}", "title": "{{ report.executable }} - {{report.crash_site}}",
"body": "## Files\n\n* input: [{{ report.input_blob.name }}]({{ input_url }})\n* exe: [{{ report.executable }}]( {{ target_url }})\n* report: [{{ report_filename }}]({{ report_url }})\n\n## Repro\n\n `{{ repro_cmd }}`\n\n## Call Stack\n\n```{% for item in report.call_stack %}{{ item }}\n{% endfor %}```\n\n## ASAN Log\n\n```{{ report.asan_log }}```", "body": "## Files\n\n* input: [{{ report.input_blob.name }}]({{ input_url }})\n* exe: [{{ report.executable }}]( {{ target_url }})\n* report: [{{ report_filename }}]({{ report_url }})\n\n## Repro\n\n `{{ repro_cmd }}`\n\n## Call Stack\n\n```{{ for item in report.call_stack }}{{ item }}\n{{ end }}```\n\n## ASAN Log\n\n```{{ report.asan_log }}```",
"unique_search": { "unique_search": {
"field_match": ["title"], "field_match": ["title"],
"string": "{{ report.executable }}" "string": "{{ report.executable }}"
@ -76,4 +76,4 @@ issues will be created and updated based on the reports.
The OneFuzz SDK provides an example tool [fake-report.py](../../src/cli/examples/fake-report.py), The OneFuzz SDK provides an example tool [fake-report.py](../../src/cli/examples/fake-report.py),
which can be used to generate a synthetic crash report to verify the integration which can be used to generate a synthetic crash report to verify the integration
is functional. is functional.