Package io.github.cdklabs.projen.github

Class GitHubOptions.Jsii$Proxy

  • All Implemented Interfaces:
    GitHubOptions, software.amazon.jsii.JsiiSerializable
    Enclosing interface:
    GitHubOptions
    @Stability(Experimental)
@Internal
public static final class GitHubOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements GitHubOptions
    An implementation for GitHubOptions

    • Constructor Detail

      • Jsii$Proxy

        protected Jsii$Proxy​(software.amazon.jsii.JsiiObjectRef objRef)
        Constructor that initializes the object based on values retrieved from the JsiiObject.
        Parameters:
        objRef - Reference to the JSII managed object.

    • Method Detail

      • getDownloadLfs

        public final Boolean getDownloadLfs()
        Description copied from interface: GitHubOptions
        (experimental) Download files in LFS in workflows.

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

        Specified by:
        getDownloadLfs in interface GitHubOptions

      • getMergify

        public final Boolean getMergify()
        Description copied from interface: GitHubOptions
        (experimental) Whether mergify should be enabled on this repository or not.

        Default: true

        Specified by:
        getMergify in interface GitHubOptions

      • getProjenCredentials

        public final GithubCredentials getProjenCredentials()
        Description copied from interface: GitHubOptions
        (experimental) Choose a method of providing GitHub API access for projen workflows.

        Default: - use a personal access token named PROJEN_GITHUB_TOKEN

        Specified by:
        getProjenCredentials in interface GitHubOptions

      • getProjenTokenSecret

        public final String getProjenTokenSecret()
        Description copied from interface: GitHubOptions
        (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"

        Specified by:
        getProjenTokenSecret in interface GitHubOptions

      • getPullRequestLint

        public final Boolean getPullRequestLint()
        Description copied from interface: GitHubOptions
        (experimental) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.

        Default: true

        Specified by:
        getPullRequestLint in interface GitHubOptions

      • getWorkflows

        public final Boolean getWorkflows()
        Description copied from interface: GitHubOptions
        (experimental) Enables GitHub workflows.

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

        Default: true

        Specified by:
        getWorkflows in interface GitHubOptions

      • $jsii$toJson

        @Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
        Specified by:
        $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object