This key defines the Pull Request templates available on your Site.
The value is an array of template objects. Each template object can contain optional label, title, body, template_path, and _inputs keys.
This key has no default.
Type
Array<pull_request_templates[*]>
Items
This key represents an individual pull request template object in the pull_request_templates array.
The value is an object that defines a template for pull requests. Each template can contain label, title, body, template_path, and _inputs keys.
Appears in: pull_request_templates.
Show examplesHide examples
In this example, we have configured a Pull Request template with a label, title, body, and input configuration.
Copied to clipboard
pull_request_templates:
- label: General changes
title: Updates to...
body: In this update, I have made the following changes...
_inputs:
title:
options:
required: true
body:
type: markdown
options:
bold: true
italic: true
link: true
format: p h1 h2 h3{
"pull_request_templates": [
{
"label": "General changes",
"title": "Updates to...",
"body": "In this update, I have made the following changes...",
"_inputs": {
"title": {
"options": {
"required": true
}
},
"body": {
"type": "markdown",
"options": {
"bold": true,
"italic": true,
"link": true,
"format": "p h1 h2 h3"
}
}
}
}
]
}Examples
In this example, we have two Pull Request templates in the pull_request_templates array.
Copied to clipboard
pull_request_templates:
- label: General changes
_inputs:
title:
options:
required: true
body:
type: markdown
options:
bold: true
italic: true
link: true
format: p h1 h2 h3
- label: Delete content
title: Delete content
_inputs:
title:
options:
disabled: true
template_path: .github/templates/delete-content.md{
"pull_request_templates": [
{
"label": "General changes",
"_inputs": {
"title": {
"options": {
"required": true
}
},
"body": {
"type": "markdown",
"options": {
"bold": true,
"italic": true,
"link": true,
"format": "p h1 h2 h3"
}
}
}
},
{
"label": "Delete content",
"title": "Delete content",
"_inputs": {
"title": {
"options": {
"disabled": true
}
}
},
"template_path": ".github/templates/delete-content.md"
}
]
}