GitHub

Edit configuration files

Perform modifications on configuration files, such as yaml or ini, and creates a pull request.

Inputs

Expand All

Field

Type

Description

repository [required]

string

The github repository, formatted as {owner}/{repo}, in which to perform the changes. Note: the format organization/repo.git is not supported.

operations [required]

[object]

The collection of operations to perform.

file [required]

string

File

Path to the file to be modified;

syntax

enum

Syntax

The syntax to use to parse the file. If set to "auto", the syntax is determined automatically on a best effort basis. Defaults to "auto". Allowed enum values: ini,yaml,json,auto

ops [required]

[]

Operations

The actual modifications to perform.

targetBranch

string

The base branch of pull request. If not specified, we use the default branch (ex. main). If a new branch is created, it is created off of this branch.

headBranch

string

Branch to create and put this commit on. If the branch already exists, changes will be force pushed. Defaults to "datadog-workflow-{{ InstanceId }}"

default: datadog-workflow-{{ InstanceId }}

createPr

boolean

If true, a pull request will be open with your changes. Defaults to true.

default: true

prTitle

string

The title of the pull request to create.

default: [Datadog Workflows] Changes from {{ WorkflowName }}

prDescription

string

The description for the pull request to create.

Outputs

Field

Type

Description

data [required]

author [required]

string

title [required]

string