Pipeline: List Pull Requests

List pull requests in the repository.

Run the pipeline

To run this pipeline from your terminal:

flowpipe pipeline run github.pipeline.list_pull_requests \
  --arg 'repository_owner=<string>' \
  --arg 'repository_name=<string>' \
  --arg 'pull_request_limit=<number>' \
  --arg 'pull_request_state=<string>'

Use this pipeline

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

step "pipeline" "step_name" {
  pipeline = github.pipeline.list_pull_requests  
  args = {
    repository_owner = <string>
    repository_name = <string>
    pull_request_limit = <number>
    pull_request_state = <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_limit	number	Yes	Returns the first n elements from the list.	-
pull_request_state	string	Yes	The state to filter the pull requests by. Allowed values are CLOSED, MERGED and OPEN.	-

Outputs

Name	Description
pull_requests	List of pull requests.