Agent SwarmTemplates

Weekly Code Health Reports

Schedule
v1.0.0

Gallery entry point for the community Code Maat + D3 code-health report package. Run a weekly report and update a stable page in place.

code-quality
maintenance
reporting
community-template
Placeholders to fill:{{REPO_URL}}{{BRANCH}}{{SCOPE_PATH}}{{REPORT_NAME}}{{PAGE_ID}}{{TIMEZONE}}

Template Content

Weekly Code Health Reports

Run a recurring Code Maat + D3 code-health report for a repository and update the same stable report page in place.

This schedule is the templates gallery entry point for the community package in templates/community/code-health-reports/. The package itself is intentionally not an agent-template config; it is a runnable playbook bundle (PLAYBOOK.md, run.sh, report.mjs, and lead-prompt.md) used by this schedule.

Schedule

{
  "cron": "0 21 * * 0",
  "timezone": "UTC",
  "agentRole": "worker",
  "enabled": true
}

Scheduled Task

This is a reusable starting prompt. Before enabling it, replace the repository, scope, branch, report name, page ID, timezone, and worker targeting details with values for your project.

Task Type: Weekly Code Health Reports

Repository: https://github.com/OWNER/REPO.git Default branch: main Path scope: src Report name: my-repo Stable page ID: <PAGE_ID>

Instructions

  1. Use the community template in templates/community/code-health-reports/. See the docs playbook at https://docs.agent-swarm.dev/docs/playbooks/code-health-reports for the full setup and attribution notes.

  2. Install or update the runner workspace under /workspace/code-maat:

    • run.sh
    • report.mjs
    • lead-prompt.md

  3. Run the report with project-specific parameters:

    BASE_DIR=/workspace/code-maat \
REPO_NAME=my-repo \
REPO_URL=https://github.com/OWNER/REPO.git \
BRANCH=main \
SCOPE_PATH=src \
bash /workspace/code-maat/run.sh

  4. Publish /workspace/code-maat/out/my-repo/latest.html to the existing stable page ID. Do not create a new page for routine refreshes.

  5. Verify the rendered page loads and the D3 charts are not blank.

  6. If the run fails because of a local runner, dependency, branch, or report-generator issue, diagnose and fix it before reporting failure.

Cadence

The default cron is 0 21 * * 0, weekly on Sunday at 21:00 UTC. Change the cron field to adjust when the report refreshes, and change timezone if the cron should be interpreted in a different zone.

The cadence is separate from page identity. Keep updating the same page ID so the report URL remains stable.

Completion

Call store-progress with status completed and an output summary that includes the stable page URL, report workspace path, commit analyzed, generated timestamp, and any dependency or chart-rendering issues found.