Skip to main content

Checklist before merging

Frontmatter​

  • task: block with label, workspace and activity. Without activity, the sync does not create the task.
  • activity with the exact name of the activity that already exists. Otherwise the sync creates another one and moves the task.
  • model is the slug of an active tier (tier-N).
  • Final folder name: renaming it later creates another task.
  • Right types in the YAML: true, not "true". A wrong type is silently discarded.
  • parameters_schema with additionalProperties: false, or null if the task takes no parameters.
  • Complete required_secrets, including configuration ids.
  • schedules with the exact name of an existing environment (or one declared in kadu.yaml) and the cron checked. timezone declared if the time is not UTC.

Body​

  • Starts with step.started and mark_body_started.
  • Every event has type and message.
  • Every call to an external API goes through log_http_call; bulk tool traffic goes summarized in append_log.
  • Helpers that do the bulk of the work instrument their own steps.
  • Every configuration variable read in the body is in required_secrets.
  • No question to the user on the automatic path.
  • Ambiguity and failure become pending items, not a stop.
  • .execution-result.json with result in Markdown and summary with counters, also written on the error path.
  • No secret value in an event, log, pending item or result.

Validation​

  • Ran in simulation (/kadu:agent-run-task <plugin>:<skill>).
  • Passed the CI sandbox smoke test.
  • Repository README.md updated (the workspace's task table).

After the merge​

  • Sync with no warnings for the skill; task under "Tasks created" or "Tasks updated" with the expected fields.
  • Secrets with a value in the environment, before the first scheduled time.
  • Endpoint credential registered, if the task declares endpoint.
  • First run checked: timeline, logs, pending items and result.