relizy / MergePreviewPullRequest
Interface: MergePreviewPullRequest
Defined in: packages/relizy/src/core/merge-preview/context.ts:13
The pull/merge request a CI job previews, read from the environment of the job: GitHub Actions (pull_request events) and GitLab CI (merge request pipelines).
Properties
body?
optionalbody?:string
Defined in: packages/relizy/src/core/merge-preview/context.ts:22
Description: the body of a squash merge on GitHub, with the PR_BODY setting
headSha?
optionalheadSha?:string
Defined in: packages/relizy/src/core/merge-preview/context.ts:26
Last commit of the pull request, when the CI gives it
kind
kind:
"merge request"|"pull request"
Defined in: packages/relizy/src/core/merge-preview/context.ts:16
pull request on GitHub, merge request on GitLab
number?
optionalnumber?:number
Defined in: packages/relizy/src/core/merge-preview/context.ts:18
Number of the pull request, IID of the merge request
provider
provider:
"github"|"gitlab"
Defined in: packages/relizy/src/core/merge-preview/context.ts:14
targetBranch
targetBranch:
string
Defined in: packages/relizy/src/core/merge-preview/context.ts:24
Branch the pull request merges into
title?
optionaltitle?:string
Defined in: packages/relizy/src/core/merge-preview/context.ts:20
Title, without the draft marker of GitLab: the commit message of a squash merge