Checklet¶

checklet mtrchk.org.momotor.render.diff.RenderDiff(recipe, product, config, results, task_id, work_dir=None)¶

Generate a report with a side-by-side diff between two files.

tasks@scheduler option¶

Enable multiple tasks for this step. If not provided, a single task is generated for this step.

See Scheduler tasks option for the documentation of this option.

Type:: string
Required:: False
Multiple:: False
Location:: config, recipe, step
Default:: No default

Provided by: StepTasksCheckletMixin

label option¶

Label for this step. Momotor LTI uses labels as the header of the step in the result view. If a step does not have a label, Momotor LTI will use the step id as the label.

Can contain reference placeholders and task id placeholders.

Type:: Any
Required:: False
Multiple:: False
Location:: config, step, recipe
Default:: No default

Provided by: LabelOptionMixin

font option¶

Font name(s) to use for the diff output. Multiple fonts can be specified, separated by commas

Type:: Any
Required:: False
Multiple:: False
Location:: config, step, recipe
Default:: Consolas,"Courier New",monospace

Provided by: RenderDiffMixin

left-header option¶

Diff table left header

Type:: Any
Required:: False
Multiple:: False
Location:: config, step, recipe
Default:: Left

Provided by: RenderDiffMixin

right-header option¶

Diff table right header

Type:: Any
Required:: False
Multiple:: False
Location:: config, step, recipe
Default:: Right

Provided by: RenderDiffMixin

diff-tab-size option¶

Expand tabs in the diff to this many spaces

Type:: integer
Required:: False
Multiple:: False
Location:: config, step, recipe
Default:: 4

Provided by: RenderDiffMixin

diff-columns option¶

Diff table column width

Type:: integer
Required:: False
Multiple:: False
Location:: config, step, recipe
Default:: 60

Provided by: RenderDiffMixin

diff-context-lines option¶

Amount of context to show on the diff. -1 for full diff

Type:: integer
Required:: False
Multiple:: False
Location:: config, step, recipe
Default:: 4

Provided by: RenderDiffMixin

ignore-final-newline option¶

Ignore difference in final newline

Type:: boolean
Required:: False
Multiple:: False
Location:: config, step, recipe
Default:: False

Provided by: RenderDiffMixin

secret option¶

Dynamic secret property value for the result. Momotor LTI will not show steps with a secret property set to true to learners, but will still show that step to reviewers.

The option value can be one of the following:

always or true: adds a secret property with value true to the result.
false: do not add a secret property to the result.
on-fail: adds a secret property with value true to the result if the step fails.
on-pass: adds a secret property with value true to the result if the step passed.
default: inherits the value from the next provider. If the last provider is ‘default’ no property will be added.

Note that this only adds a secret property with value true, but never one with value false. This ensures that a default defined in a recipe will be used unless the step or config explicitly override it.

The value can contain reference placeholders to inherit the value from another step’s options or properties.