Skip to content

Document and validate draft: true default for create-pull-request #11337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 2 commits into from
Closed

Document and validate draft: true default for create-pull-request #11337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f926aa
Initial plan
Copilot Jan 22, 2026
769db7a
Add validation and documentation for draft: true default
Copilot Jan 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions actions/setup/js/create_pull_request.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ async function main(config = {}) {
// Extract configuration
const titlePrefix = config.title_prefix || "";
const envLabels = config.labels ? (Array.isArray(config.labels) ? config.labels : config.labels.split(",")).map(label => String(label).trim()).filter(label => label) : [];
// Default to draft: true for security - ensures AI-generated PRs cannot be auto-merged accidentally
// and gives reviewers a chance to review code before it goes live
const draftDefault = config.draft !== undefined ? config.draft : true;
const ifNoChanges = config.if_no_changes || "warn";
const allowEmpty = config.allow_empty || false;
Expand Down
14 changes: 12 additions & 2 deletions pkg/workflow/create_pull_request.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ type CreatePullRequestsConfig struct {
Labels []string `yaml:"labels,omitempty"`
AllowedLabels []string `yaml:"allowed-labels,omitempty"` // Optional list of allowed labels. If omitted, any labels are allowed (including creating new ones).
Reviewers []string `yaml:"reviewers,omitempty"` // List of users/bots to assign as reviewers to the pull request
Draft *bool `yaml:"draft,omitempty"` // Pointer to distinguish between unset (nil) and explicitly false
Draft *bool `yaml:"draft,omitempty"` // Create as draft PR. Defaults to true if omitted. Use explicit false for auto-merge workflows.
IfNoChanges string `yaml:"if-no-changes,omitempty"` // Behavior when no changes to push: "warn" (default), "error", or "ignore"
AllowEmpty bool `yaml:"allow-empty,omitempty"` // Allow creating PR without patch file or with empty patch (useful for preparing feature branches)
TargetRepoSlug string `yaml:"target-repo,omitempty"` // Target repository in format "owner/repo" for cross-repository pull requests
Expand Down Expand Up @@ -66,7 +66,9 @@ func (c *Compiler) buildCreateOutputPullRequestJob(data *WorkflowData, mainJobNa
customEnvVars = append(customEnvVars, buildTitlePrefixEnvVar("GH_AW_PR_TITLE_PREFIX", data.SafeOutputs.CreatePullRequests.TitlePrefix)...)
customEnvVars = append(customEnvVars, buildLabelsEnvVar("GH_AW_PR_LABELS", data.SafeOutputs.CreatePullRequests.Labels)...)
customEnvVars = append(customEnvVars, buildLabelsEnvVar("GH_AW_PR_ALLOWED_LABELS", data.SafeOutputs.CreatePullRequests.AllowedLabels)...)
// Pass draft setting - default to true for backwards compatibility
// Pass draft setting - default to true to ensure agentic workflows create draft PRs
// This is a security best practice: draft PRs cannot be auto-merged accidentally
// and give reviewers a chance to review AI-generated code before it goes live
draftValue := true // Default value
if data.SafeOutputs.CreatePullRequests.Draft != nil {
draftValue = *data.SafeOutputs.CreatePullRequests.Draft
Expand Down Expand Up @@ -204,6 +206,14 @@ func (c *Compiler) parsePullRequestsConfig(outputMap map[string]any) *CreatePull
return nil // Invalid configuration, return nil to cause validation error
}

// Check if draft is explicitly set to false - this is allowed but discouraged
// The default is true to ensure agentic workflows create draft PRs by default
if config.Draft != nil && *config.Draft == false {
createPRLog.Print("WARNING: draft: false is explicitly set - agentic workflows should create draft PRs by default")
// Note: This is informational only - we don't block the compilation
// Some workflows (e.g., with auto-merge: true) intentionally use draft: false
}

// Log expires if configured
if config.Expires > 0 {
createPRLog.Printf("Pull request expiration configured: %d hours", config.Expires)
Expand Down