Skip to main content

Github Pull Request Template

GithubPullRequestTemplate​

A reusable template for GitHub pull request descriptions.

It holds Markdown that GithubRepository and GithubRepositoryTemplate manifests reference by name. The engine writes the content to .github/pull_request_template.md in the target repository.

PropertyTypeDescription
apiVersionstringAPI schema version. Must be lowops.manifests.v1.
kindstringResource kind. Must be GithubPullRequestTemplate.
metadatamapThe engine reads the reserved keys name and organization to resolve the identity and the parent GithubConnection.
specSpecDesired pull request template. See Spec.

Spec​

User-provided pull request template definition.

The Markdown content and an optional description.

PropertyTypeDescription
descriptionstringOptional description of the template. It is informational only.
contentstringMarkdown body that pre-fills the description of new pull requests. A GithubRepository or GithubRepositoryTemplate references this manifest by name in its pull_request.template field. The engine writes the content to .github/pull_request_template.md in that repository.