Skip to content

[plan] Update safe-outputs docs: remove "same-repo only" and document cross-repo push_to_pull_request_branch #28371

@github-actions

Description

@github-actions

Objective

Update documentation to reflect that push_to_pull_request_branch now supports cross-repo usage. Remove the "same-repo only" limitation note and add cross-repo setup instructions.

Context

Issue #21306: docs/src/content/docs/reference/safe-outputs.md line 41 currently states push-to-PR-branch is "same-repo only". After the code fixes, this is no longer true.

Changes Needed

docs/src/content/docs/reference/safe-outputs.md

  • Remove "same-repo only" from the Push to PR Branch bullet (line ~41)
  • Replace with: cross-repo is supported when target-repo is set and the target repository is checked out with a path in the workflow's checkout config

docs/src/content/docs/reference/safe-outputs-pull-requests.md

  • In the Push to PR Branch section, add a "Cross-repo usage" subsection:
    • When using target-repo (and optionally allowed-repos), the target repository must be checked out in the workflow workspace (e.g. checkout: - repository: org/target-repo; path: ./target-repo)
    • Link to cross-repository.md and the existing example showing push-to-pull-request-branch: target-repo: "org/target-repo"
    • Add a minimal YAML snippet demonstrating the checkout + push-to-pull-request-branch config together

docs/src/content/docs/reference/cross-repository.md (if needed)

  • Confirm or add that push_to_pull_request_branch is supported with target-repo alongside create_pull_request

Acceptance Criteria

  • "same-repo only" text removed from safe-outputs.md
  • Cross-repo setup instructions documented with example YAML
  • checkout path requirement clearly stated
  • Links between cross-repository.md and safe-outputs-pull-requests.md are consistent
    Related to Make push_to_pull_request_branch cross-repo #21306

Generated by Plan Command for issue #21306 · ● 147.1K ·

  • expires on Apr 26, 2026, 11:51 PM UTC

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions