anthony.wen/cds-ai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add ATVM coverage and functional sections to status template

Browse Source 
- update the ATVM status template to include COVERAGE: and FUNCTIONALLY: sections ahead of the existing summary tables
- document that COVERAGE: should describe intended run scope without listing target hosts
- document that FUNCTIONALLY: should summarize the intended workflow steps at a high level
- align the ATVM automation guide so local status output and Mattermost posts use the expanded default format
This commit is contained in:
anthony.wen
2026-03-24 22:10:25 -04:00
parent 86b1a0e4a9
commit 0bf07f0e9c
2 changed files with 28 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
atvm/docs/automation/status-template.md
View File

@@ -10,6 +10,18 @@ Use this as the default ATVM automation run-status template for:
## ATVM Run Status
### <build_name>
**COVERAGE:**
- template: `<template-name>`
- datastore/config family: `<config family>`
- migration style: `<high-level test style>`
- integration/plugin path: `<integration/plugin>`
- scope of this run: `<batch or run scope>`
**FUNCTIONALLY:**
- <intended functional step>
- <intended functional step>
- <intended functional step>
**SUMMARY:**
| Metric | Value |
@@ -45,10 +57,11 @@ Use this as the default ATVM automation run-status template for:
```
## Rules
- Keep `SUMMARY:`, `HOSTS:`, `TIMING:`, and `NOTES:` in that order.
- Keep `COVERAGE:`, `FUNCTIONALLY:`, `SUMMARY:`, `HOSTS:`, `TIMING:`, and `NOTES:` in that order.
- Use the title format:
- `## ATVM Run Status`
- `### <build_name>`
- Use flat bullet lists for `COVERAGE:` and `FUNCTIONALLY:`.
- Use Markdown tables for `SUMMARY:`, `HOSTS:`, and `TIMING:`.
- Use one host per row in the `HOSTS:` section.
- For completed hosts, prefer:
@@ -59,4 +72,6 @@ Use this as the default ATVM automation run-status template for:
- `⏭️ SKIP`
- Keep `Detail` concise.
- Put broader context under `NOTES:`, not in the host table.
- `COVERAGE:` should describe what the run was intended to cover without listing target hosts.
- `FUNCTIONALLY:` should describe the intended workflow steps at a high level, even if the run failed before completing them.
- Use the same template for Mattermost and local operator-visible status output.