io.github.cdklabs.projen.github

Class GitHub.Builder

java.lang.Object

io.github.cdklabs.projen.github.GitHub.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHub>

Enclosing class:

GitHub

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

(experimental) A fluent builder for GitHub.

Method Summary

Modifier and Type	Method and Description
GitHub	build()
static GitHub.Builder	create(Project project)
GitHub.Builder	mergify(Boolean mergify) (experimental) Whether mergify should be enabled on this repository or not.
GitHub.Builder	mergifyOptions(MergifyOptions mergifyOptions) (experimental) Options for Mergify.
GitHub.Builder	pullRequestLint(Boolean pullRequestLint) (experimental) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.
GitHub.Builder	pullRequestLintOptions(PullRequestLintOptions pullRequestLintOptions) (experimental) Options for configuring a pull request linter.
GitHub.Builder	workflows(Boolean workflows) (experimental) Enables GitHub workflows.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static GitHub.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of GitHub.Builder.

mergify

@Stability(value=Experimental)
public GitHub.Builder mergify(Boolean mergify)

(experimental) Whether mergify should be enabled on this repository or not.

Default: true

Parameters:

mergify - Whether mergify should be enabled on this repository or not. This parameter is required.

Returns:

this

mergifyOptions

@Stability(value=Experimental)
public GitHub.Builder mergifyOptions(MergifyOptions mergifyOptions)

(experimental) Options for Mergify.

Default: - default options

Parameters:

mergifyOptions - Options for Mergify. This parameter is required.

Returns:

this

pullRequestLint

@Stability(value=Experimental)
public GitHub.Builder pullRequestLint(Boolean pullRequestLint)

(experimental) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.

Default: true

Parameters:

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

Returns:

this

pullRequestLintOptions

@Stability(value=Experimental)
public GitHub.Builder pullRequestLintOptions(PullRequestLintOptions pullRequestLintOptions)

(experimental) Options for configuring a pull request linter.

Default: - see defaults in `PullRequestLintOptions`

Parameters:

pullRequestLintOptions - Options for configuring a pull request linter. This parameter is required.

Returns:

this

workflows

@Stability(value=Experimental)
public GitHub.Builder workflows(Boolean workflows)

(experimental) Enables GitHub workflows.

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

Default: true

Parameters:

workflows - Enables GitHub workflows. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public GitHub build()

Specified by:

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