Skip to content

[WORKFLOW] Create Documentation Generation Workflow #5

@raegAI

Description

@raegAI

@claude Please create a new GitHub Actions workflow file .github/workflows/claude-documentation.yml that:

Requirements:

  • Triggers after the testing & debugging workflow completes (claude-test-debug.yml)
  • Creates/updates documentation in a new /CC_progress directory
  • Reads the test results and console output from previous workflows
  • Generates comprehensive progress documentation

Documentation Structure:
Create /CC_progress/progress.md with:

  • Summary Section: Brief overview of what Claude Code accomplished
  • Changes Made: Detailed list of files modified/created/deleted
  • Test Results: Complete test output and status
  • Debugging Actions: What was debugged and how it was fixed
  • Console Output: Final console output from testing phase
  • Status: Overall success/failure status
  • Next Steps: Recommendations for future development

Key Features:

  • Parse workflow artifacts from previous steps
  • Use GitHub API to gather commit information
  • Format markdown with proper headings and code blocks
  • Include timestamps and workflow run references
  • Auto-link to related issues and PRs
  • Update existing progress.md or create new entry with timestamps

Technical Requirements:

  • Access to repository files and commit history
  • Read artifacts from previous workflow runs
  • Create proper markdown formatting
  • Handle multiple concurrent workflow runs
  • Maintain documentation history

Integration:

  • Link back to originating issue/PR
  • Tag documentation updates in issues
  • Create artifact with documentation for potential merging workflow

Please implement this with comprehensive documentation generation and proper GitHub integration.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions