Github PullRequest

kind: github

Description

The pullrequests section describes the GitHub Pull Requests that updatecli is expected to open (or update) when the manifest is applied.

Parameters

NameRequiredDefaultDescription

automerge

false

Enable the GitHub "auto-merge" feature for the pull request

description

""

Prepend a custom description to the pull request body message generated by updatecli

draft

false

Set this pull request in a draft state (as defined by GitHub)

labels

[]

Set the labels of this pull request (list of labels)

maintainercannotmodify

false

Forbid maintainers to edit the pull request

mergemethod

Set pullrequest merge method, accepted values ["squash", "rebase", "merge"]

title

""

Set the pull request title

Example

# updatecli.yaml
scms:
  website:
    kind: "github"
    spec:
      user: "user"
      email: "updatecli@example."
      owner: "updatecli"
      repository: "website"
      token: '{{ requiredEnv GITHUB_TOKEN }}'
      username: "{{ requiredEnv GITHUB_AUTHOR }}"
      branch: "main"

# Define pullrequest configuration if one needs to be created
pullrequests:
  helm-charts:
    kind: "github"
    scmID: "website"
    spec:
      automerge: true
      description: "Prepend description"
      draft: false
      labels:
        - "dependencies"
        - "epinio"
      title: "PullRequest Title"
#
#sources:
#conditions:
#targets:

Edit this page on GitHub