Work Package Prompt: WP04 – Automation - Reporting & GitHub Actions

Objectives & Success Criteria

  • Automate the daily sync process.
  • Provide visible reporting via GitHub Issues and Jekyll.
  • Implement the “Confirmed” human-in-the-loop workflow.

Context & Constraints

  • Integrates all previous WPs into a lifecycle.
  • Uses GitHub API for automation.

Subtasks & Detailed Guidance

Subtask T013 – Implement GitHub Issue Creator for gaps

  • Purpose: Surface findings as actionable items.
  • Steps:
    1. Use PyGithub to create issues from the Gap Analysis JSON.
    2. Label issues as documentation-gap.
  • Files: /crawler/github_integration.py.

Subtask T014 – Implement Jekyll Gap Report generator

  • Purpose: High-level library health dashboard.
  • Steps:
    1. Process gap JSON into Markdown files in content/reports/.
    2. Ensure Jekyll renders these as a table of missing items.
  • Files: /crawler/transformers/report_generator.py.

Subtask T015 – Create GitHub Action workflow

  • Purpose: Evergreen synchronization.
  • Steps:
    1. Create .github/workflows/daily-sync.yml.
    2. Configure cron schedule (daily).
    3. Include logic to commit and push mirrored content.
  • Files: /.github/workflows/daily-sync.yml.

Subtask T016 – Implement Comment-Triggered Workflow

  • Purpose: Approve AI upgrades.
  • Steps:
    1. Listen for /confirm or “Confirmed” comments on issues.
    2. Trigger the “upgraded” status flag for the respective page and commit the change.
  • Files: /.github/workflows/approval-trigger.yml.

Risks & Mitigations

  • Risk: GitHub Actions execution time limits.
  • Mitigation: Use sync-state tracking (T004) to perform partial/incremental runs.

Activity Log

  • 2026-03-04T12:15:00Z – system – lane=planned – Prompt created.