Skip to content

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

@willtsai

Description

@willtsai

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

Metadata

Metadata

Labels

triagedThis issue has been reviewed and triaged

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions