Pipeline: Create Pull Request

Creates a pull request.

Run the pipeline

To run this pipeline from your terminal:

flowpipe pipeline run github.pipeline.create_pull_request \
  --arg 'repository_owner=<string>' \
  --arg 'repository_name=<string>' \
  --arg 'pull_request_title=<string>' \
  --arg 'pull_request_body=<string>' \
  --arg 'base_branch=<string>' \
  --arg 'head_branch=<string>'

Use this pipeline

To call this pipeline from your pipeline, use a step:

step "pipeline" "step_name" {
  pipeline = github.pipeline.create_pull_request  
  args = {
    repository_owner = <string>
    repository_name = <string>
    pull_request_title = <string>
    pull_request_body = <string>
    base_branch = <string>
    head_branch = <string>
  }
}

Params

Name	Type	Required	Description	Default
conn	connection.github	Yes	Name of Github connection to use. If not provided, the default Github connection will be used.	`connection.github.default`
repository_owner	string	Yes	The organization or user name.	-
repository_name	string	Yes	The name of the repository.	-
pull_request_title	string	Yes	The title of the pull request.	-
pull_request_body	string	Yes	The contents of the pull request.	-
base_branch	string	Yes	The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.	-
head_branch	string	Yes	The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head_ref_name with a user like this: username:branch.	-

Outputs

Name	Description
pull_request	Pull request details.

Pipeline: Create Pull Request

Run the pipeline

Use this pipeline

Params

Outputs

Tags