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 forGitHubProjectOptions
-
-
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 protectedJsii$Proxy(GitHubProjectOptions.Builder builder)Constructor that initializes the object based on literal property values passed by theGitHubProjectOptions.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)Constructor that initializes the object based on values retrieved from the JsiiObject.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.fasterxml.jackson.databind.JsonNode$jsii$toJson()booleanequals(Object o)AutoApproveOptionsgetAutoApproveOptions()(experimental) Enable and configure the 'auto approve' workflow.BooleangetAutoMerge()(experimental) Enable automatic merging on GitHub.AutoMergeOptionsgetAutoMergeOptions()(experimental) Configure options for automatic merging on GitHub.BooleangetClobber()(experimental) Add aclobbertask which resets the repo to origin.BooleangetCommitGenerated()(experimental) Whether to commit the managed files by default.BooleangetDevContainer()(experimental) Add a VSCode development environment (used for GitHub Codespaces).BooleangetGithub()(experimental) Enable GitHub integration.GitHubOptionsgetGithubOptions()(experimental) Options for GitHub integration.IgnoreFileOptionsgetGitIgnoreOptions()(experimental) Configuration options for .gitignore file.GitOptionsgetGitOptions()(experimental) Configuration options for git.BooleangetGitpod()(experimental) Add a Gitpod development environment.LoggerOptionsgetLogging()(experimental) Configure logging options such as verbosity.BooleangetMergify()(deprecated) Whether mergify should be enabled on this repository or not.MergifyOptionsgetMergifyOptions()(deprecated) Options for mergify.StringgetName()(experimental) This is the name of your project.StringgetOutdir()(experimental) The root directory of the project.ProjectgetParent()(experimental) The parent project, if this project is part of a bigger project.ProjectTypegetProjectType()(deprecated) Which type of project this is (library/app).StringgetProjenCommand()(experimental) The shell command to use in order to run the projen CLI.GithubCredentialsgetProjenCredentials()(experimental) Choose a method of providing GitHub API access for projen workflows.BooleangetProjenrcJson()(experimental) Generate (once) .projenrc.json (in JSON).ProjenrcJsonOptionsgetProjenrcJsonOptions()(experimental) Options for .projenrc.json.StringgetProjenTokenSecret()(deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.SampleReadmePropsgetReadme()(experimental) The README setup.BooleangetRenovatebot()(experimental) Use renovatebot to handle dependency upgrades.RenovatebotOptionsgetRenovatebotOptions()(experimental) Options for renovatebot.BooleangetStale()(experimental) Auto-close of stale issues and pull request.StaleOptionsgetStaleOptions()(experimental) Auto-close stale issues and pull requests.BooleangetVscode()(experimental) Enable VSCode integration.inthashCode()
-
-
-
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 theGitHubProjectOptions.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:
getAutoApproveOptionsin interfaceGitHubProjectOptions
-
getAutoMerge
public final Boolean getAutoMerge()
Description copied from interface:GitHubProjectOptions(experimental) Enable automatic merging on GitHub.Has no effect if
github.mergifyis set to false.Default: true
- Specified by:
getAutoMergein interfaceGitHubProjectOptions
-
getAutoMergeOptions
public final AutoMergeOptions getAutoMergeOptions()
Description copied from interface:GitHubProjectOptions(experimental) Configure options for automatic merging on GitHub.Has no effect if
github.mergifyorautoMergeis set to false.Default: - see defaults in `AutoMergeOptions`
- Specified by:
getAutoMergeOptionsin interfaceGitHubProjectOptions
-
getClobber
public final Boolean getClobber()
Description copied from interface:GitHubProjectOptions(experimental) Add aclobbertask which resets the repo to origin.Default: - true, but false for subprojects
- Specified by:
getClobberin interfaceGitHubProjectOptions
-
getDevContainer
public final Boolean getDevContainer()
Description copied from interface:GitHubProjectOptions(experimental) Add a VSCode development environment (used for GitHub Codespaces).Default: false
- Specified by:
getDevContainerin interfaceGitHubProjectOptions
-
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:
getGithubin interfaceGitHubProjectOptions
-
getGithubOptions
public final GitHubOptions getGithubOptions()
Description copied from interface:GitHubProjectOptions(experimental) Options for GitHub integration.Default: - see GitHubOptions
- Specified by:
getGithubOptionsin interfaceGitHubProjectOptions
-
getGitpod
public final Boolean getGitpod()
Description copied from interface:GitHubProjectOptions(experimental) Add a Gitpod development environment.Default: false
- Specified by:
getGitpodin interfaceGitHubProjectOptions
-
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:
getMergifyin interfaceGitHubProjectOptions
-
getMergifyOptions
public final MergifyOptions getMergifyOptions()
Description copied from interface:GitHubProjectOptions(deprecated) Options for mergify.Default: - default options
- Specified by:
getMergifyOptionsin interfaceGitHubProjectOptions
-
getProjectType
public final ProjectType getProjectType()
Description copied from interface:GitHubProjectOptions(deprecated) Which type of project this is (library/app).Default: ProjectType.UNKNOWN
- Specified by:
getProjectTypein interfaceGitHubProjectOptions
-
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:
getProjenCredentialsin interfaceGitHubProjectOptions
-
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,workflowsandpackagesscope.Default: "PROJEN_GITHUB_TOKEN"
- Specified by:
getProjenTokenSecretin interfaceGitHubProjectOptions
-
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:
getReadmein interfaceGitHubProjectOptions
-
getStale
public final Boolean getStale()
Description copied from interface:GitHubProjectOptions(experimental) Auto-close of stale issues and pull request.See
staleOptionsfor options.Default: false
- Specified by:
getStalein interfaceGitHubProjectOptions
-
getStaleOptions
public final StaleOptions getStaleOptions()
Description copied from interface:GitHubProjectOptions(experimental) Auto-close stale issues and pull requests.To disable set
staletofalse.Default: - see defaults in `StaleOptions`
- Specified by:
getStaleOptionsin interfaceGitHubProjectOptions
-
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:
getVscodein interfaceGitHubProjectOptions
-
getName
public final String getName()
Description copied from interface:ProjectOptions(experimental) This is the name of your project.Default: $BASEDIR
- Specified by:
getNamein interfaceProjectOptions
-
getCommitGenerated
public final Boolean getCommitGenerated()
Description copied from interface:ProjectOptions(experimental) Whether to commit the managed files by default.Default: true
- Specified by:
getCommitGeneratedin interfaceProjectOptions
-
getGitIgnoreOptions
public final IgnoreFileOptions getGitIgnoreOptions()
Description copied from interface:ProjectOptions(experimental) Configuration options for .gitignore file.- Specified by:
getGitIgnoreOptionsin interfaceProjectOptions
-
getGitOptions
public final GitOptions getGitOptions()
Description copied from interface:ProjectOptions(experimental) Configuration options for git.- Specified by:
getGitOptionsin interfaceProjectOptions
-
getLogging
public final LoggerOptions getLogging()
Description copied from interface:ProjectOptions(experimental) Configure logging options such as verbosity.Default: {}
- Specified by:
getLoggingin interfaceProjectOptions
-
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:
getOutdirin interfaceProjectOptions
-
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:
getParentin interfaceProjectOptions
-
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:
getProjenCommandin interfaceProjectOptions
-
getProjenrcJson
public final Boolean getProjenrcJson()
Description copied from interface:ProjectOptions(experimental) Generate (once) .projenrc.json (in JSON). Set tofalsein order to disable .projenrc.json generation.Default: false
- Specified by:
getProjenrcJsonin interfaceProjectOptions
-
getProjenrcJsonOptions
public final ProjenrcJsonOptions getProjenrcJsonOptions()
Description copied from interface:ProjectOptions(experimental) Options for .projenrc.json.Default: - default options
- Specified by:
getProjenrcJsonOptionsin interfaceProjectOptions
-
getRenovatebot
public final Boolean getRenovatebot()
Description copied from interface:ProjectOptions(experimental) Use renovatebot to handle dependency upgrades.Default: false
- Specified by:
getRenovatebotin interfaceProjectOptions
-
getRenovatebotOptions
public final RenovatebotOptions getRenovatebotOptions()
Description copied from interface:ProjectOptions(experimental) Options for renovatebot.Default: - default options
- Specified by:
getRenovatebotOptionsin interfaceProjectOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-