[docs] Update documentation for base-branch field in create-pull-request #15112
+13
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add documentation for the new base-branch configuration option in the create-pull-request safe output. This field allows workflows to specify which branch a pull request should target, particularly useful for cross-repository workflows targeting non-default branches. Changes: - Add base-branch field to create-pull-request YAML example - Document default behavior (defaults to github.ref_name) - Include use case example for cross-repo PR targeting vnext branch Related: #15089 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
github-actions
bot
added
automation
documentation
pelikhan
deleted the
docs/update-base-branch-field-2026-02-12-419463e98555c3c2
branch
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation Updates - 2026-02-12
This PR updates the documentation based on features merged in the last 24 hours.
Features Documented
base-branchfield for cross-repo PRs (from Addbase-branchfield for cross-repo PRs targeting non-default branches #15089) - Added documentation for the newbase-branchconfiguration option increate-pull-requestsafe outputChanges Made
docs/src/content/docs/reference/safe-outputs.mdto document thebase-branchfieldMerged PRs Referenced
base-branchfield for cross-repo PRs targeting non-default branches #15089 - Addbase-branchfield for cross-repo PRs targeting non-default branchesSummary
The
base-branchfield allows workflows to specify which branch a pull request should target. This is particularly valuable for cross-repository workflows that need to create PRs targeting non-default branches (such asvnext,release/*, orstagingbranches).The documentation update includes:
github.ref_nameorg/engineeringcreating PRs inorg/docstargeting thevnextbranchThe documentation follows the Diátaxis framework (Reference type), maintains the neutral technical tone, and provides minimal but complete examples as specified in the documentation guidelines.