Github

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

NameTypeDescriptionRequired
automergebooleanSpecifies if automerge is enabled for the new pullrequest
descriptionstringSpecifies user input description used during pull body creation
draftbooleanSpecifies if a pull request is set to draft, default false
labelsarraySpecifies repository labels used for pull request. !! Labels must already exist on the repository
maintainercannotmodifybooleanSpecifies if maintainer can modify pullRequest
mergemethodstringSpecifies which merge method is used to incorporate the pull request. Accept "merge", "squash", "rebase", or ""
titlestringSpecifies pull request title
usetitleforautomergebooleanSpecifies to use pull request title when using auto merge, only works for "squash" or "rebase"

Example

# updatecli.yaml
name: Update a file content and open a GitHub Pull Request

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"

targets:
  default:
    scmid: website
    kind: file
    # spec:
    # ...
Top