Automating cross-repo documentation with GitHub Agentic Workflows

Summary

Maintaining documentation across separate repositories often leads to severe lag because technical writers must reverse-engineer shipped features weeks after release. To address this in the Aspire project, the team implemented an automated pipeline using GitHub Agentic Workflows to bridge the product and documentation repositories. When product pull requests merge, a bash step maps milestones to docs release branches before an LLM agent evaluates the diff, drafts documentation updates, and emits structured pull request intents. A dedicated safe-outputs handler materializes these drafts via a scoped GitHub App and assigns the original code reviewers to verify accuracy. Across 396 product pull requests, the system generated 82 documentation pull requests that all merged with a median turnaround time of 44.8 hours.

Takeaways

1. 1

   Security is preserved by isolating model execution to read operations and delegating pull request creation to a safe-outputs handler restricted by explicit branch, file, and repository allow-lists.

2. 2

   Deterministic branch resolution using pull request and issue milestones prevents the model from guessing or misrouting documentation target branches.

3. 3

   Pre-extracting pull request metadata and issue details in bash steps avoids exceeding model prompt token budgets on large diffs.