CreatePullRequest

Create a pull request on GitHub from the current branch to a specified branch. If a pull request for those already exists, this step will overwrite the title and body of the existing pull request.

Parameters

base

The branch to create the pull request against. This is required.

title.template

A template string for the title of the pull request. This is required.

title.variables

An optional map of variables to use in the title template.

body.template

A template string for the body of the pull request. This is required.

body.variables

An optional map of variables to use in the body template.

Example

An example workflow which creates a pull request from the current branch to main using the current version of the package as the title and the changelog entry for the current version as the body:

[[workflows]]
name = "create-release-pull-request"

[[workflows.steps]]
type = "CreatePullRequest"

[workflows.steps.base]
default = "main"

[workflows.steps.title]
template = "chore: Release $version"
variables = { "$version" = "Version" }

[workflows.steps.body]
template = "Merging this PR will release the following:\n\n$changelog"
variables = { "$changelog" = "ChangelogEntry" }

For a full example of how this might be used with GitHub Actions to help automate releases, check out Knope's prepare-release workflow and Knope's release workflow.