Package io.github.cdklabs.projen.github

Interface GitHubOptions

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    GitHubOptions.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.100.0 (build 6a776be)",
           date="2024-06-21T23:10:12.003Z")
@Stability(Experimental)
public interface GitHubOptions
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getDownloadLfs

        @Stability(Experimental)
@Nullable
default Boolean getDownloadLfs()
        (experimental) Download files in LFS in workflows.

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

      • getMergify

        @Stability(Experimental)
@Nullable
default Boolean getMergify()
        (experimental) Whether mergify should be enabled on this repository or not.

        Default: true

      • getMergifyOptions

        @Stability(Experimental)
@Nullable
default MergifyOptions getMergifyOptions()
        (experimental) Options for Mergify.

        Default: - default options

      • getProjenCredentials

        @Stability(Experimental)
@Nullable
default GithubCredentials getProjenCredentials()
        (experimental) Choose a method of providing GitHub API access for projen workflows.

        Default: - use a personal access token named PROJEN_GITHUB_TOKEN

      • getProjenTokenSecret

        @Stability(Deprecated)
@Deprecated
@Nullable
default String getProjenTokenSecret()
        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"

      • getPullRequestBackport

        @Stability(Experimental)
@Nullable
default Boolean getPullRequestBackport()
        (experimental) Add a workflow that allows backport of PRs to other branches using labels.

        When opening a new PR add a backport label to it, and the PR will be backported to the target branches once the PR is merged.

        Should not be used together with mergify.

        Default: false

      • getPullRequestBackportOptions

        @Stability(Experimental)
@Nullable
default PullRequestBackportOptions getPullRequestBackportOptions()
        (experimental) Options for configuring pull request backport.

        Default: - see defaults in `PullRequestBackportOptions`

      • getPullRequestLint

        @Stability(Experimental)
@Nullable
default Boolean getPullRequestLint()
        (experimental) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.

        Default: true

      • getPullRequestLintOptions

        @Stability(Experimental)
@Nullable
default PullRequestLintOptions getPullRequestLintOptions()
        (experimental) Options for configuring a pull request linter.

        Default: - see defaults in `PullRequestLintOptions`

      • getWorkflows

        @Stability(Experimental)
@Nullable
default Boolean getWorkflows()
        (experimental) Enables GitHub workflows.

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

        Default: true