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.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.070Z")
@Stability(Experimental)
public interface GitHubOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GitHubOptions.Builder	A builder for GitHubOptions
static class	GitHubOptions.Jsii$Proxy	An implementation for GitHubOptions

Method Summary

Modifier and Type	Method	Description
static GitHubOptions.Builder	builder()
default Boolean	getDownloadLfs()	(experimental) Download files in LFS in workflows.
default Boolean	getMergify()	(experimental) Whether mergify should be enabled on this repository or not.
default MergifyOptions	getMergifyOptions()	(experimental) Options for Mergify.
default GithubCredentials	getProjenCredentials()	(experimental) Choose a method of providing GitHub API access for projen workflows.
default String	getProjenTokenSecret()	Deprecated. use projenCredentials
default Boolean	getPullRequestLint()	(experimental) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.
default PullRequestLintOptions	getPullRequestLintOptions()	(experimental) Options for configuring a pull request linter.
default Boolean	getWorkflows()	(experimental) Enables GitHub workflows.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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"

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

builder

@Stability(Experimental)
static GitHubOptions.Builder builder()

Returns:

a GitHubOptions.Builder of GitHubOptions