Package io.github.cdklabs.projen.github

Class GitHubOptions.Builder

java.lang.Object

io.github.cdklabs.projen.github.GitHubOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubOptions>

Enclosing interface:

GitHubOptions

@Stability(Experimental)
public static final class GitHubOptions.Builder
extends Object
implements software.amazon.jsii.Builder<GitHubOptions>

A builder for GitHubOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubOptions	build()	Builds the configured instance.
GitHubOptions.Builder	downloadLfs(Boolean downloadLfs)	Sets the value of GitHubOptions.getDownloadLfs()
GitHubOptions.Builder	mergify(Boolean mergify)	Sets the value of GitHubOptions.getMergify()
GitHubOptions.Builder	mergifyOptions(MergifyOptions mergifyOptions)	Sets the value of GitHubOptions.getMergifyOptions()
GitHubOptions.Builder	projenCredentials(GithubCredentials projenCredentials)	Sets the value of GitHubOptions.getProjenCredentials()
GitHubOptions.Builder	projenTokenSecret(String projenTokenSecret)	Deprecated. - use `projenCredentials`
GitHubOptions.Builder	pullRequestLint(Boolean pullRequestLint)	Sets the value of GitHubOptions.getPullRequestLint()
GitHubOptions.Builder	pullRequestLintOptions(PullRequestLintOptions pullRequestLintOptions)	Sets the value of GitHubOptions.getPullRequestLintOptions()
GitHubOptions.Builder	workflows(Boolean workflows)	Sets the value of GitHubOptions.getWorkflows()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

downloadLfs

@Stability(Experimental)
public GitHubOptions.Builder downloadLfs(Boolean downloadLfs)

Sets the value of GitHubOptions.getDownloadLfs()

Parameters:

downloadLfs - Download files in LFS in workflows.

Returns:

this

mergify

@Stability(Experimental)
public GitHubOptions.Builder mergify(Boolean mergify)

Sets the value of GitHubOptions.getMergify()

Parameters:

mergify - Whether mergify should be enabled on this repository or not.

Returns:

this

mergifyOptions

@Stability(Experimental)
public GitHubOptions.Builder mergifyOptions(MergifyOptions mergifyOptions)

Sets the value of GitHubOptions.getMergifyOptions()

Parameters:

mergifyOptions - Options for Mergify.

Returns:

this

projenCredentials

@Stability(Experimental)
public GitHubOptions.Builder projenCredentials(GithubCredentials projenCredentials)

Sets the value of GitHubOptions.getProjenCredentials()

Parameters:

projenCredentials - Choose a method of providing GitHub API access for projen workflows.

Returns:

this

projenTokenSecret

@Stability(Deprecated)
@Deprecated
public GitHubOptions.Builder projenTokenSecret(String projenTokenSecret)

Deprecated.

- use `projenCredentials`

Sets the value of GitHubOptions.getProjenTokenSecret()

Parameters:

projenTokenSecret - The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the repo, workflows and packages scope.

Returns:

this

pullRequestLint

@Stability(Experimental)
public GitHubOptions.Builder pullRequestLint(Boolean pullRequestLint)

Sets the value of GitHubOptions.getPullRequestLint()

Parameters:

pullRequestLint - Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.

Returns:

this

pullRequestLintOptions

@Stability(Experimental)
public GitHubOptions.Builder pullRequestLintOptions(PullRequestLintOptions pullRequestLintOptions)

Sets the value of GitHubOptions.getPullRequestLintOptions()

Parameters:

pullRequestLintOptions - Options for configuring a pull request linter.

Returns:

this

workflows

@Stability(Experimental)
public GitHubOptions.Builder workflows(Boolean workflows)

Sets the value of GitHubOptions.getWorkflows()

Parameters:

workflows - Enables GitHub workflows. If this is set to false, workflows will not be created.

Returns:

this

build

@Stability(Experimental)
public GitHubOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GitHubOptions>

Returns:

a new instance of GitHubOptions

Throws:

NullPointerException - if any required attribute was not provided