You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

step-04-generate-report.md 3.3KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. ---
  2. name: 'step-04-generate-report'
  3. description: 'Create test-review report and validate'
  4. outputFile: '{test_artifacts}/test-review.md'
  5. ---
  6. # Step 4: Generate Report & Validate
  7. ## STEP GOAL
  8. Produce the test-review report and validate against checklist.
  9. ## MANDATORY EXECUTION RULES
  10. - 📖 Read the entire step file before acting
  11. - ✅ Speak in `{communication_language}`
  12. ---
  13. ## EXECUTION PROTOCOLS:
  14. - 🎯 Follow the MANDATORY SEQUENCE exactly
  15. - 💾 Record outputs before proceeding
  16. - 📖 Load the next step only when instructed
  17. ## CONTEXT BOUNDARIES:
  18. - Available context: config, loaded artifacts, and knowledge fragments
  19. - Focus: this step's goal only
  20. - Limits: do not execute future steps
  21. - Dependencies: prior steps' outputs (if any)
  22. ## MANDATORY SEQUENCE
  23. **CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise.
  24. ## 1. Report Generation
  25. Use `test-review-template.md` to produce `{outputFile}` including:
  26. - Score summary
  27. - Critical findings with fixes
  28. - Warnings and recommendations
  29. - Context references (story/test-design if available)
  30. - Coverage boundary note: `test-review` does not score coverage. Direct coverage findings to `trace`.
  31. ---
  32. ## 2. Polish Output
  33. Before finalizing, review the complete output document for quality:
  34. 1. **Remove duplication**: Progressive-append workflow may have created repeated sections — consolidate
  35. 2. **Verify consistency**: Ensure terminology, risk scores, and references are consistent throughout
  36. 3. **Check completeness**: All template sections should be populated or explicitly marked N/A
  37. 4. **Format cleanup**: Ensure markdown formatting is clean (tables aligned, headers consistent, no orphaned references)
  38. ---
  39. ## 3. Validation
  40. Validate against `checklist.md` and fix any gaps.
  41. - [ ] CLI sessions cleaned up (no orphaned browsers)
  42. - [ ] Temp artifacts stored in `{test_artifacts}/` not random locations
  43. ---
  44. ## 4. Save Progress
  45. **Save this step's accumulated work to `{outputFile}`.**
  46. - **If `{outputFile}` does not exist** (first save), create it using the workflow template (if available) with YAML frontmatter:
  47. ```yaml
  48. ---
  49. stepsCompleted: ['step-04-generate-report']
  50. lastStep: 'step-04-generate-report'
  51. lastSaved: '{date}'
  52. ---
  53. ```
  54. Then write this step's output below the frontmatter.
  55. - **If `{outputFile}` already exists**, update:
  56. - Add `'step-04-generate-report'` to `stepsCompleted` array (only if not already present)
  57. - Set `lastStep: 'step-04-generate-report'`
  58. - Set `lastSaved: '{date}'`
  59. - Append this step's output to the appropriate section of the document.
  60. ---
  61. ## 5. Completion Summary
  62. Report:
  63. - Scope reviewed
  64. - Overall score
  65. - Critical blockers
  66. - Next recommended workflow (e.g., `automate` or `trace`)
  67. ## 🚨 SYSTEM SUCCESS/FAILURE METRICS:
  68. ### ✅ SUCCESS:
  69. - Step completed in full with required outputs
  70. ### ❌ SYSTEM FAILURE:
  71. - Skipped sequence steps or missing outputs
  72. **Master Rule:** Skipping steps is FORBIDDEN.
  73. ## On Complete
  74. Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
  75. If the resolver succeeds and returns a non-empty `workflow.on_complete`, execute that value as the final terminal instruction before exiting.
  76. If the resolver fails, returns no output, or resolves an empty value, skip the hook and exit normally.