Enhance publish-docs workflow: Include triggering upstream PR details in autogenerated docs PRs#11159
Enhance publish-docs workflow: Include triggering upstream PR details in autogenerated docs PRs#11159
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the publish-docs GitHub Actions workflow so autogenerated PRs to the docs repo include richer context about what triggered the docs generation (merged PR vs direct commit vs manual dispatch), improving traceability back to Radius changes.
Changes:
- Add a workflow step to infer trigger context from the triggering commit message and build a formatted PR title/body.
- Use the generated title/body outputs when creating the docs pull request.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11159 +/- ##
==========================================
- Coverage 51.40% 51.38% -0.02%
==========================================
Files 699 699
Lines 44156 44156
==========================================
- Hits 22698 22690 -8
- Misses 19291 19295 +4
- Partials 2167 2171 +4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
e6be2d1 to
6fea2d2
Compare
Dependency Review SummaryThe full dependency review summary was too large to display here (1461KB, limit is 1024KB). Please download the artifact named "dependency-review-summary" to view the complete report. |
Radius functional test overviewClick here to see the test run details
Test Status⌛ Building Radius and pushing container images for functional tests... |
Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>
d43f899 to
c3637c6
Compare
Description
The
publish-docsworkflow generates PRs against the docs repository without context about the triggering upstream change. This makes it difficult for reviewers to trace documentation updates back to source code changes.Changes
Added context extraction step that detects trigger type and formats rich PR descriptions:
Merged PRs - Extracts PR number and title from squash merge commit messages using pattern
\(#([0-9]+)\)$Update auto-generated documentation (PR #1234)Direct commits - Captures commit metadata for non-PR changes
Update auto-generated documentation (main)Manual triggers - Identifies workflow_dispatch invocations
Update auto-generated documentation (manual trigger)Implementation:
.github/scripts/prepare-docs-pr-context.shfor local testability${{ github.ref_name }}to preserve full branch names (e.g.,release/0.32)Files Changed
.github/scripts/prepare-docs-pr-context.sh- Standalone script containing PR context preparation logic.github/workflows/publish-docs.yaml- Simplified to call the script with environment variablesBefore
After
Type of change
Contributor checklist
Please verify that the PR meets the following requirements, where applicable:
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.