Package io.github.cdklabs.projen.github

Class GitHub.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<GitHub>
    Enclosing class:
    GitHub
    @Stability(Experimental)
public static final class GitHub.Builder
extends Object
implements software.amazon.jsii.Builder<GitHub>
    (experimental) A fluent builder for GitHub.

    • Method Detail

      • create

        @Stability(Experimental)
public static GitHub.Builder create​(Project project)
        Parameters:
        project - This parameter is required.
        Returns:
        a new instance of GitHub.Builder.

      • downloadLfs

        @Stability(Experimental)
public GitHub.Builder downloadLfs​(Boolean downloadLfs)
        (experimental) Download files in LFS in workflows.

        Default: true if the associated project has `lfsPatterns`, `false` otherwise

        Parameters:
        downloadLfs - Download files in LFS in workflows. This parameter is required.
        Returns:
        this

      • mergify

        @Stability(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(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

      • projenCredentials

        @Stability(Experimental)
public GitHub.Builder projenCredentials​(GithubCredentials projenCredentials)
        (experimental) Choose a method of providing GitHub API access for projen workflows.

        Default: - use a personal access token named PROJEN_GITHUB_TOKEN

        Parameters:
        projenCredentials - Choose a method of providing GitHub API access for projen workflows. This parameter is required.
        Returns:
        this

      • projenTokenSecret

        @Stability(Deprecated)
@Deprecated
public GitHub.Builder projenTokenSecret​(String projenTokenSecret)
        Deprecated.
        • use projenCredentials
        (deprecated) 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.

        Default: "PROJEN_GITHUB_TOKEN"

        Parameters:
        projenTokenSecret - The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This parameter is required.
        Returns:
        this

      • pullRequestLint

        @Stability(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(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(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(Experimental)
public GitHub build()
        Specified by:
        build in interface software.amazon.jsii.Builder<GitHub>
        Returns:
        a newly built instance of GitHub.