Github Pull Request
kind: github/pullrequest
Description
The actions section describes the GitHub Pull Requests that updatecli is expected to open (or update) when the manifest is applied.
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| automerge | boolean | Specifies if automerge is enabled for the new pullrequest | |
| description | string | Specifies user input description used during pull body creation | |
| draft | boolean | Specifies if a Pull Request is set to draft, default false | |
| labels | array | Specifies repository labels used for the Pull Request. !! Labels must already exist on the repository | |
| maintainercannotmodify | boolean | Specifies if maintainer can modify pullRequest | |
| mergemethod | string | Specifies which merge method is used to incorporate the Pull Request. Accept “merge”, “squash”, “rebase”, or "" | |
| parent | boolean | Specifies if a Pull Request should be sent to the parent of a fork. | |
| title | string | Specifies the Pull Request title | |
| usetitleforautomerge | boolean | Specifies to use the Pull Request title as commit message 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 action configurations if one needs to be created
actions:
helm-charts:
kind: "github"
scmid: "website"
spec:
automerge: true
description: "Prepend description"
draft: false
labels:
- "dependencies"
- "epinio"
title: "Pull Request Title"
targets:
default:
scmid: website
kind: file
# spec:
# ...