Skip to content

Enhance publish-docs workflow: Include triggering upstream PR details in autogenerated docs PRs#11159

Open
Copilot wants to merge 1 commit intomainfrom
copilot/enhance-publish-docs-workflow
Open

Enhance publish-docs workflow: Include triggering upstream PR details in autogenerated docs PRs#11159
Copilot wants to merge 1 commit intomainfrom
copilot/enhance-publish-docs-workflow

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 3, 2026

Description

The publish-docs workflow 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:

  1. Merged PRs - Extracts PR number and title from squash merge commit messages using pattern \(#([0-9]+)\)$

    • Title: Update auto-generated documentation (PR #1234)
    • Body: Links to upstream PR, includes title, author, branch, commit SHA
  2. Direct commits - Captures commit metadata for non-PR changes

    • Title: Update auto-generated documentation (main)
    • Body: Branch name, commit link, author, commit message
  3. Manual triggers - Identifies workflow_dispatch invocations

    • Title: Update auto-generated documentation (manual trigger)
    • Body: Trigger source, actor, branch, commit

Implementation:

  • Extracted trigger detection logic to .github/scripts/prepare-docs-pr-context.sh for local testability
  • Workflow passes GitHub context via environment variables
  • Uses ${{ github.ref_name }} to preserve full branch names (e.g., release/0.32)
  • No API calls or additional permissions required

Files Changed

  • New: .github/scripts/prepare-docs-pr-context.sh - Standalone script containing PR context preparation logic
  • Modified: .github/workflows/publish-docs.yaml - Simplified to call the script with environment variables

Before

Title: Update auto-generated documentation
Body:  GitHub SHA: abc123

After

Title: Update auto-generated documentation (PR #1234)
Body:
  **Pull Request:** #1234 - Fix CLI command docs
  **Author:** Jane Developer
  **Branch:** release/0.32
  **Commit:** abc123

Type of change

  • This pull request adds or changes features of Radius and has an approved issue (issue link required).

Contributor checklist

Please verify that the PR meets the following requirements, where applicable:

  • An overview of proposed schema changes is included in a linked GitHub issue.
    • Not applicable
  • A design document PR is created in the design-notes repository, if new APIs are being introduced.
    • Not applicable
  • The design document has been reviewed and approved by Radius maintainers/approvers.
    • Not applicable
  • A PR for the samples repository is created, if existing samples are affected by the changes in this PR.
    • Not applicable
  • A PR for the documentation repository is created, if the changes in this PR affect the documentation or any user facing updates are made.
    • Not applicable
  • A PR for the recipes repository is created, if existing recipes are affected by the changes in this PR.
    • Not applicable
Original prompt

This section details on the original issue you should resolve

<issue_title>Enhance publish-docs workflow: Include triggering upstream PR details in autogenerated docs PRs</issue_title>
<issue_description>## Background

The current .github/workflows/publish-docs.yaml workflow in the radius repository generates a pull request (PR) against the docs repository whenever reference documentation is auto-generated. However, the resulting PR that is created is sparse on details and does not make it clear which upstream PR or commit triggered the workflow to run.

Request

Please update the publish-docs workflow so that the auto-generated documentation PR includes clear information on:

  • The upstream PR (or commit) in the radius repo that triggered the workflow.
  • Preferably, a link to that upstream PR or commit and basic context (such as PR title/author or commit message).

This will make it easier for reviewers and maintainers to understand the source of documentation changes and trace them back to the originating changes in the codebase.

File reference: radius-project/radius/.github/workflows/publish-docs.yaml


Acceptance Criteria

  • Auto-generated documentation PRs should include upstream PR/commit details in the PR title and/or body
  • Information must include at least a link to the upstream PR/commit, and ideally context such as PR title/author
  • Implementation should be documented or commented if workaround is required

/cc @radius-project/maintainers</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 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.

Copilot AI changed the title [WIP] Enhance publish-docs workflow to include upstream PR details Enhance publish-docs workflow: Include triggering upstream PR details in autogenerated docs PRs Feb 3, 2026
Copilot AI requested a review from willtsai February 3, 2026 22:30
@willtsai willtsai had a problem deploying to external-contributor-approval March 3, 2026 21:28 — with GitHub Actions Failure
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 3, 2026

Unit Tests

    2 files  ±0    415 suites  ±0   6m 49s ⏱️ +11s
4 872 tests ±0  4 870 ✅ ±0  2 💤 ±0  0 ❌ ±0 
5 774 runs  ±0  5 772 ✅ ±0  2 💤 ±0  0 ❌ ±0 

Results for commit c3637c6. ± Comparison against base commit 2ea450a.

♻️ This comment has been updated with latest results.

@willtsai willtsai marked this pull request as ready for review March 3, 2026 22:45
@willtsai willtsai requested a review from a team as a code owner March 3, 2026 22:45
Copilot AI review requested due to automatic review settings March 3, 2026 22:45
@willtsai willtsai requested review from a team as code owners March 3, 2026 22:45
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown

codecov bot commented Mar 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51.38%. Comparing base (2ea450a) to head (c3637c6).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@willtsai willtsai requested a deployment to external-contributor-approval March 30, 2026 20:58 — with GitHub Actions Waiting
@willtsai willtsai requested a deployment to external-contributor-approval March 30, 2026 21:08 — with GitHub Actions Waiting
@willtsai willtsai force-pushed the copilot/enhance-publish-docs-workflow branch from e6be2d1 to 6fea2d2 Compare March 30, 2026 21:12
@willtsai willtsai requested a deployment to external-contributor-approval March 30, 2026 21:12 — with GitHub Actions Waiting
@willtsai willtsai requested a deployment to external-contributor-approval March 30, 2026 21:12 — with GitHub Actions Waiting
@github-actions
Copy link
Copy Markdown

Dependency Review Summary

The 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.

View full job summary

@willtsai willtsai temporarily deployed to external-contributor-approval March 30, 2026 21:29 — with GitHub Actions Inactive
@radius-functional-tests
Copy link
Copy Markdown

radius-functional-tests bot commented Mar 30, 2026

Radius functional test overview

🔍 Go to test action run

Click here to see the test run details
Name Value
Repository radius-project/radius
Commit ref 33673d3
Unique ID func6ca0b72b8b
Image tag pr-func6ca0b72b8b
  • gotestsum 1.13.0
  • KinD: v0.29.0
  • Dapr: 1.14.4
  • Azure KeyVault CSI driver: 1.4.2
  • Azure Workload identity webhook: 1.3.0
  • Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func6ca0b72b8b
  • Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
  • applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func6ca0b72b8b
  • dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-func6ca0b72b8b
  • controller test image location: ghcr.io/radius-project/dev/controller:pr-func6ca0b72b8b
  • ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func6ca0b72b8b
  • deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

@willtsai willtsai requested a deployment to external-contributor-approval March 31, 2026 17:11 — with GitHub Actions Waiting
@willtsai willtsai requested a deployment to external-contributor-approval April 6, 2026 18:15 — with GitHub Actions Waiting
Signed-off-by: Will Tsai <28876888+willtsai@users.noreply.github.com>
@willtsai willtsai force-pushed the copilot/enhance-publish-docs-workflow branch from d43f899 to c3637c6 Compare April 6, 2026 18:20
@willtsai willtsai requested a deployment to external-contributor-approval April 6, 2026 18:20 — with GitHub Actions Waiting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enhance publish-docs workflow: Include triggering upstream PR details in autogenerated docs PRs

3 participants