Package io.github.cdklabs.projen.github

Class GitHubProjectOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.github.GitHubProjectOptions.Jsii$Proxy

All Implemented Interfaces:

GitHubProjectOptions, ProjectOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

GitHubProjectOptions

@Stability(Experimental)
@Internal
public static final class GitHubProjectOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements GitHubProjectOptions

An implementation for GitHubProjectOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

GitHubProjectOptions.Builder, GitHubProjectOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(GitHubProjectOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the GitHubProjectOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
AutoApproveOptions	getAutoApproveOptions()	(experimental) Enable and configure the 'auto approve' workflow.
Boolean	getAutoMerge()	(experimental) Enable automatic merging on GitHub.
AutoMergeOptions	getAutoMergeOptions()	(experimental) Configure options for automatic merging on GitHub.
Boolean	getClobber()	(experimental) Add a clobber task which resets the repo to origin.
Boolean	getCommitGenerated()	(experimental) Whether to commit the managed files by default.
Boolean	getDevContainer()	(experimental) Add a VSCode development environment (used for GitHub Codespaces).
Boolean	getGithub()	(experimental) Enable GitHub integration.
GitHubOptions	getGithubOptions()	(experimental) Options for GitHub integration.
IgnoreFileOptions	getGitIgnoreOptions()	(experimental) Configuration options for .gitignore file.
GitOptions	getGitOptions()	(experimental) Configuration options for git.
Boolean	getGitpod()	(experimental) Add a Gitpod development environment.
LoggerOptions	getLogging()	(experimental) Configure logging options such as verbosity.
Boolean	getMergify()	(deprecated) Whether mergify should be enabled on this repository or not.
MergifyOptions	getMergifyOptions()	(deprecated) Options for mergify.
String	getName()	(experimental) This is the name of your project.
String	getOutdir()	(experimental) The root directory of the project.
Project	getParent()	(experimental) The parent project, if this project is part of a bigger project.
ProjectType	getProjectType()	(deprecated) Which type of project this is (library/app).
String	getProjenCommand()	(experimental) The shell command to use in order to run the projen CLI.
GithubCredentials	getProjenCredentials()	(experimental) Choose a method of providing GitHub API access for projen workflows.
Boolean	getProjenrcJson()	(experimental) Generate (once) .projenrc.json (in JSON).
ProjenrcJsonOptions	getProjenrcJsonOptions()	(experimental) Options for .projenrc.json.
String	getProjenTokenSecret()	(deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
SampleReadmeProps	getReadme()	(experimental) The README setup.
Boolean	getRenovatebot()	(experimental) Use renovatebot to handle dependency upgrades.
RenovatebotOptions	getRenovatebotOptions()	(experimental) Options for renovatebot.
Boolean	getStale()	(experimental) Auto-close of stale issues and pull request.
StaleOptions	getStaleOptions()	(experimental) Auto-close stale issues and pull requests.
Boolean	getVscode()	(experimental) Enable VSCode integration.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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.

Jsii$Proxy

protected Jsii$Proxy(GitHubProjectOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the GitHubProjectOptions.Builder.

Method Detail

getAutoApproveOptions

public final AutoApproveOptions getAutoApproveOptions()

Description copied from interface: GitHubProjectOptions

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

Default: - auto approve is disabled

Specified by:

getAutoApproveOptions in interface GitHubProjectOptions

getAutoMerge

public final Boolean getAutoMerge()

Description copied from interface: GitHubProjectOptions

(experimental) Enable automatic merging on GitHub.

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

Default: true

Specified by:

getAutoMerge in interface GitHubProjectOptions

getAutoMergeOptions

public final AutoMergeOptions getAutoMergeOptions()

Description copied from interface: GitHubProjectOptions

(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`

Specified by:

getAutoMergeOptions in interface GitHubProjectOptions

getClobber

public final Boolean getClobber()

Description copied from interface: GitHubProjectOptions

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

Default: - true, but false for subprojects

Specified by:

getClobber in interface GitHubProjectOptions

getDevContainer

public final Boolean getDevContainer()

Description copied from interface: GitHubProjectOptions

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

Default: false

Specified by:

getDevContainer in interface GitHubProjectOptions

getGithub

public final Boolean getGithub()

Description copied from interface: GitHubProjectOptions

(experimental) Enable GitHub integration.

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

Default: true

Specified by:

getGithub in interface GitHubProjectOptions

getGithubOptions

public final GitHubOptions getGithubOptions()

Description copied from interface: GitHubProjectOptions

(experimental) Options for GitHub integration.

Default: - see GitHubOptions

Specified by:

getGithubOptions in interface GitHubProjectOptions

getGitpod

public final Boolean getGitpod()

Description copied from interface: GitHubProjectOptions

(experimental) Add a Gitpod development environment.

Default: false

Specified by:

getGitpod in interface GitHubProjectOptions

getMergify

public final Boolean getMergify()

Description copied from interface: GitHubProjectOptions

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

Default: true

Specified by:

getMergify in interface GitHubProjectOptions

getMergifyOptions

public final MergifyOptions getMergifyOptions()

Description copied from interface: GitHubProjectOptions

(deprecated) Options for mergify.

Default: - default options

Specified by:

getMergifyOptions in interface GitHubProjectOptions

getProjectType

public final ProjectType getProjectType()

Description copied from interface: GitHubProjectOptions

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

Default: ProjectType.UNKNOWN

Specified by:

getProjectType in interface GitHubProjectOptions

getProjenCredentials

public final GithubCredentials getProjenCredentials()

Description copied from interface: GitHubProjectOptions

(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 GitHubProjectOptions

getProjenTokenSecret

public final String getProjenTokenSecret()

Description copied from interface: GitHubProjectOptions

(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 GitHubProjectOptions

getReadme

public final SampleReadmeProps getReadme()

Description copied from interface: GitHubProjectOptions

(experimental) The README setup.

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

Example:

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

Specified by:

getReadme in interface GitHubProjectOptions

getStale

public final Boolean getStale()

Description copied from interface: GitHubProjectOptions

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

See staleOptions for options.

Default: false

Specified by:

getStale in interface GitHubProjectOptions

getStaleOptions

public final StaleOptions getStaleOptions()

Description copied from interface: GitHubProjectOptions

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

To disable set stale to false.

Default: - see defaults in `StaleOptions`

Specified by:

getStaleOptions in interface GitHubProjectOptions

getVscode

public final Boolean getVscode()

Description copied from interface: GitHubProjectOptions

(experimental) Enable VSCode integration.

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

Default: true

Specified by:

getVscode in interface GitHubProjectOptions

getName

public final String getName()

Description copied from interface: ProjectOptions

(experimental) This is the name of your project.

Default: $BASEDIR

Specified by:

getName in interface ProjectOptions

getCommitGenerated

public final Boolean getCommitGenerated()

Description copied from interface: ProjectOptions

(experimental) Whether to commit the managed files by default.

Default: true

Specified by:

getCommitGenerated in interface ProjectOptions

getGitIgnoreOptions

public final IgnoreFileOptions getGitIgnoreOptions()

Description copied from interface: ProjectOptions

(experimental) Configuration options for .gitignore file.

Specified by:

getGitIgnoreOptions in interface ProjectOptions

getGitOptions

public final GitOptions getGitOptions()

Description copied from interface: ProjectOptions

(experimental) Configuration options for git.

Specified by:

getGitOptions in interface ProjectOptions

getLogging

public final LoggerOptions getLogging()

Description copied from interface: ProjectOptions

(experimental) Configure logging options such as verbosity.

Default: {}

Specified by:

getLogging in interface ProjectOptions

getOutdir

public final String getOutdir()

Description copied from interface: ProjectOptions

(experimental) The root directory of the project.

Relative to this directory, all files are synthesized.

If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.

Default: "."

Specified by:

getOutdir in interface ProjectOptions

getParent

public final Project getParent()

Description copied from interface: ProjectOptions

(experimental) The parent project, if this project is part of a bigger project.

Specified by:

getParent in interface ProjectOptions

getProjenCommand

public final String getProjenCommand()

Description copied from interface: ProjectOptions

(experimental) The shell command to use in order to run the projen CLI.

Can be used to customize in special environments.

Default: "npx projen"

Specified by:

getProjenCommand in interface ProjectOptions

getProjenrcJson

public final Boolean getProjenrcJson()

Description copied from interface: ProjectOptions

(experimental) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

Default: false

Specified by:

getProjenrcJson in interface ProjectOptions

getProjenrcJsonOptions

public final ProjenrcJsonOptions getProjenrcJsonOptions()

Description copied from interface: ProjectOptions

(experimental) Options for .projenrc.json.

Default: - default options

Specified by:

getProjenrcJsonOptions in interface ProjectOptions

getRenovatebot

public final Boolean getRenovatebot()

Description copied from interface: ProjectOptions

(experimental) Use renovatebot to handle dependency upgrades.

Default: false

Specified by:

getRenovatebot in interface ProjectOptions

getRenovatebotOptions

public final RenovatebotOptions getRenovatebotOptions()

Description copied from interface: ProjectOptions

(experimental) Options for renovatebot.

Default: - default options

Specified by:

getRenovatebotOptions in interface ProjectOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object