Package io.github.cdklabs.projen.github

Interface GitHubProjectOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ProjectOptions

All Known Subinterfaces:

AwsCdkConstructLibraryOptions, AwsCdkJavaAppOptions, AwsCdkPythonAppOptions, AwsCdkTypeScriptAppOptions, Cdk8sPythonOptions, Cdk8sTypeScriptAppOptions, ConstructLibraryAwsOptions, ConstructLibraryCdk8sOptions, ConstructLibraryCdktfOptions, ConstructLibraryOptions, JavaProjectCommonOptions, JavaProjectOptions, JsiiProjectOptions, NextJsProjectOptions, NextJsTypeScriptProjectOptions, NodeProjectOptions, PythonProjectOptions, ReactProjectOptions, ReactTypeScriptProjectOptions, TypeScriptLibraryProjectOptions, TypeScriptProjectOptions

All Known Implementing Classes:

AwsCdkConstructLibraryOptions.Jsii$Proxy, AwsCdkJavaAppOptions.Jsii$Proxy, AwsCdkPythonAppOptions.Jsii$Proxy, AwsCdkTypeScriptAppOptions.Jsii$Proxy, Cdk8sPythonOptions.Jsii$Proxy, Cdk8sTypeScriptAppOptions.Jsii$Proxy, ConstructLibraryAwsOptions.Jsii$Proxy, ConstructLibraryCdk8sOptions.Jsii$Proxy, ConstructLibraryCdktfOptions.Jsii$Proxy, ConstructLibraryOptions.Jsii$Proxy, GitHubProjectOptions.Jsii$Proxy, JavaProjectCommonOptions.Jsii$Proxy, JavaProjectOptions.Jsii$Proxy, JsiiProjectOptions.Jsii$Proxy, NextJsProjectOptions.Jsii$Proxy, NextJsTypeScriptProjectOptions.Jsii$Proxy, NodeProjectOptions.Jsii$Proxy, PythonProjectOptions.Jsii$Proxy, ReactProjectOptions.Jsii$Proxy, ReactTypeScriptProjectOptions.Jsii$Proxy, TypeScriptLibraryProjectOptions.Jsii$Proxy, TypeScriptProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.080Z")
@Stability(Experimental)
public interface GitHubProjectOptions
extends software.amazon.jsii.JsiiSerializable, ProjectOptions

(experimental) Options for GitHubProject.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GitHubProjectOptions.Builder	builder()
default AutoApproveOptions	getAutoApproveOptions()	(experimental) Enable and configure the 'auto approve' workflow.
default Boolean	getAutoMerge()	(experimental) Enable automatic merging on GitHub.
default AutoMergeOptions	getAutoMergeOptions()	(experimental) Configure options for automatic merging on GitHub.
default Boolean	getClobber()	(experimental) Add a clobber task which resets the repo to origin.
default Boolean	getDevContainer()	(experimental) Add a VSCode development environment (used for GitHub Codespaces).
default Boolean	getGithub()	(experimental) Enable GitHub integration.
default GitHubOptions	getGithubOptions()	(experimental) Options for GitHub integration.
default Boolean	getGitpod()	(experimental) Add a Gitpod development environment.
default Boolean	getMergify()	Deprecated. use githubOptions.mergify instead
default MergifyOptions	getMergifyOptions()	Deprecated. use githubOptions.mergifyOptions instead
default ProjectType	getProjectType()	Deprecated. no longer supported at the base project level
default GithubCredentials	getProjenCredentials()	(experimental) Choose a method of providing GitHub API access for projen workflows.
default String	getProjenTokenSecret()	Deprecated. use projenCredentials
default SampleReadmeProps	getReadme()	(experimental) The README setup.
default Boolean	getStale()	(experimental) Auto-close of stale issues and pull request.
default StaleOptions	getStaleOptions()	(experimental) Auto-close stale issues and pull requests.
default Boolean	getVscode()	(experimental) Enable VSCode integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

getCommitGenerated, getGitIgnoreOptions, getGitOptions, getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions, getRenovatebot, getRenovatebotOptions

Method Detail

getAutoApproveOptions

@Stability(Experimental)
@Nullable
default AutoApproveOptions getAutoApproveOptions()

(experimental) Enable and configure the 'auto approve' workflow.

Default: - auto approve is disabled

getAutoMerge

@Stability(Experimental)
@Nullable
default Boolean getAutoMerge()

(experimental) Enable automatic merging on GitHub.

Has no effect if github.mergify is set to false.

Default: true

getAutoMergeOptions

@Stability(Experimental)
@Nullable
default AutoMergeOptions getAutoMergeOptions()

(experimental) Configure options for automatic merging on GitHub.

Has no effect if github.mergify or autoMerge is set to false.

Default: - see defaults in `AutoMergeOptions`

getClobber

@Stability(Experimental)
@Nullable
default Boolean getClobber()

(experimental) Add a clobber task which resets the repo to origin.

Default: - true, but false for subprojects

getDevContainer

@Stability(Experimental)
@Nullable
default Boolean getDevContainer()

(experimental) Add a VSCode development environment (used for GitHub Codespaces).

Default: false

getGithub

@Stability(Experimental)
@Nullable
default Boolean getGithub()

(experimental) Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

Default: true

getGithubOptions

@Stability(Experimental)
@Nullable
default GitHubOptions getGithubOptions()

(experimental) Options for GitHub integration.

Default: - see GitHubOptions

getGitpod

@Stability(Experimental)
@Nullable
default Boolean getGitpod()

(experimental) Add a Gitpod development environment.

Default: false

getMergify

@Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getMergify()

Deprecated.

use githubOptions.mergify instead

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

Default: true

getMergifyOptions

@Stability(Deprecated)
@Deprecated
@Nullable
default MergifyOptions getMergifyOptions()

Deprecated.

use githubOptions.mergifyOptions instead

(deprecated) Options for mergify.

Default: - default options

getProjectType

@Stability(Deprecated)
@Deprecated
@Nullable
default ProjectType getProjectType()

Deprecated.

no longer supported at the base project level

(deprecated) Which type of project this is (library/app).

Default: ProjectType.UNKNOWN

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"

getReadme

@Stability(Experimental)
@Nullable
default SampleReadmeProps getReadme()

(experimental) The README setup.

Default: - { filename: 'README.md', contents: '# replace this' }

Example:

 "{ filename: 'readme.md', contents: '# title' }"
 

getStale

@Stability(Experimental)
@Nullable
default Boolean getStale()

(experimental) Auto-close of stale issues and pull request.

See staleOptions for options.

Default: false

getStaleOptions

@Stability(Experimental)
@Nullable
default StaleOptions getStaleOptions()

(experimental) Auto-close stale issues and pull requests.

To disable set stale to false.

Default: - see defaults in `StaleOptions`

getVscode

@Stability(Experimental)
@Nullable
default Boolean getVscode()

(experimental) Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

Default: true

builder

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

Returns:

a GitHubProjectOptions.Builder of GitHubProjectOptions