Packages > pkg.pkl-lang.org/pkl-pantry/com.github.dependabot > com.github.dependabot.v2.Dependabot

PullRequestBranchName1.2.0

Overview
Properties
Methods

class PullRequestBranchName

Pull request branch name preferences You can combine separator, word-separator, branch-name-case, max-length, and template to produce branch names that meet your system's requirements. For example, Docker tag compatibility, Azure Container Registry naming, or Kubernetes branch length limits.

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

separator: ("-"|"_"|"/")?Source

Change separator for PR branch name

Default if undefined: "/"

See https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#separator
link

template: String(length <= 200)?Source

Custom format template using placeholders.

See https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#template
link

prefix: String?Source

String prepended to the branch name.

Default if undefined: "dependabot"

See https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#prefix-1
link

`word-separator`: Char?Source

Character to replace underscores (_) in branch name content after the prefix.

See https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#word-separator
link

`branch-name-case`: ("lowercase"|"uppercase")?Source

Apply case transformation to the branch name content after the prefix.

See https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#branch-name-case
link

`max-length`: Int(isBetween(20, 244))?Source

Maximum character length of the branch name.

Default if not set: 100

See https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#max-length

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.