42 lines (36 loc) · 841 Bytes

Creating a basic YAML rule template

{ProductShortName} YAML-based rules have the following basic structure:

when(condition)
 message(message)
 tag(tags)

Procedure

In the /home/<USER>/ directory, create a file containing the basic syntax for YAML rules as follows:

- category: mandatory
  description: |
   <DESCRIPTION TITLE>
   <DESCRIPTION TEXT>
  effort: <EFFORT>
  labels:
  - konveyor.io/source=<SOURCE_TECH>
  - konveyor.io/target=<TARGET_TECH>
  links:
 - url: <HYPERLINK>
   title: <HYPERLINK_TITLE>
  message: <MESSAGE>
  tag:
  - <TAG1>
  - <TAG2>
  ruleID: <RULE_ID>
  when:
   <CONDITIONS>