io.github.cdklabs.projen.github

Class GitHubProject.Builder

java.lang.Object

io.github.cdklabs.projen.github.GitHubProject.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubProject>

Enclosing class:

GitHubProject

Deprecated.

@Stability(value=Deprecated)
 @Deprecated
public static final class GitHubProject.Builder
extends Object
implements software.amazon.jsii.Builder<GitHubProject>

(deprecated) A fluent builder for GitHubProject.

Method Summary

Modifier and Type	Method and Description
GitHubProject.Builder	autoApproveOptions(AutoApproveOptions autoApproveOptions) Deprecated. (experimental) Enable and configure the 'auto approve' workflow.
GitHubProject.Builder	autoMergeOptions(AutoMergeOptions autoMergeOptions) Deprecated. (experimental) Configure options for automatic merging on GitHub.
GitHubProject	build() Deprecated.
GitHubProject.Builder	clobber(Boolean clobber) Deprecated. (experimental) Add a `clobber` task which resets the repo to origin.
static GitHubProject.Builder	create() Deprecated.
GitHubProject.Builder	devContainer(Boolean devContainer) Deprecated. (experimental) Add a VSCode development environment (used for GitHub Codespaces).
GitHubProject.Builder	github(Boolean github) Deprecated. (experimental) Enable GitHub integration.
GitHubProject.Builder	githubOptions(GitHubOptions githubOptions) Deprecated. (experimental) Options for GitHub integration.
GitHubProject.Builder	gitpod(Boolean gitpod) Deprecated. (experimental) Add a Gitpod development environment.
GitHubProject.Builder	logging(LoggerOptions logging) Deprecated. (experimental) Configure logging options such as verbosity.
GitHubProject.Builder	mergify(Boolean mergify) Deprecated. use `githubOptions.mergify` instead
GitHubProject.Builder	mergifyOptions(MergifyOptions mergifyOptions) Deprecated. use `githubOptions.mergifyOptions` instead
GitHubProject.Builder	name(String name) Deprecated. (experimental) This is the name of your project.
GitHubProject.Builder	outdir(String outdir) Deprecated. (experimental) The root directory of the project.
GitHubProject.Builder	parent(Project parent) Deprecated. (experimental) The parent project, if this project is part of a bigger project.
GitHubProject.Builder	projectType(ProjectType projectType) Deprecated. no longer supported at the base project level
GitHubProject.Builder	projenCommand(String projenCommand) Deprecated. (experimental) The shell command to use in order to run the projen CLI.
GitHubProject.Builder	projenrcJson(Boolean projenrcJson) Deprecated. (experimental) Generate (once) .projenrc.json (in JSON).
GitHubProject.Builder	projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions) Deprecated. (experimental) Options for .projenrc.json.
GitHubProject.Builder	readme(SampleReadmeProps readme) Deprecated. (experimental) The README setup.
GitHubProject.Builder	stale(Boolean stale) Deprecated. (experimental) Auto-close of stale issues and pull request.
GitHubProject.Builder	staleOptions(StaleOptions staleOptions) Deprecated. (experimental) Auto-close stale issues and pull requests.
GitHubProject.Builder	vscode(Boolean vscode) Deprecated. (experimental) Enable VSCode integration.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Deprecated)
 @Deprecated
public static GitHubProject.Builder create()

Deprecated.

Returns:

a new instance of GitHubProject.Builder.

name

@Stability(value=Experimental)
public GitHubProject.Builder name(String name)

Deprecated.

(experimental) This is the name of your project.

Default: $BASEDIR

Parameters:

name - This is the name of your project. This parameter is required.

Returns:

this

logging

@Stability(value=Experimental)
public GitHubProject.Builder logging(LoggerOptions logging)

Deprecated.

(experimental) Configure logging options such as verbosity.

Default: {}

Parameters:

logging - Configure logging options such as verbosity. This parameter is required.

Returns:

this

outdir

@Stability(value=Experimental)
public GitHubProject.Builder outdir(String outdir)

Deprecated.

(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 sub-projects.

Default: "."

Parameters:

outdir - The root directory of the project. This parameter is required.

Returns:

this

parent

@Stability(value=Experimental)
public GitHubProject.Builder parent(Project parent)

Deprecated.

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

Parameters:

parent - The parent project, if this project is part of a bigger project. This parameter is required.

Returns:

this

projenCommand

@Stability(value=Experimental)
public GitHubProject.Builder projenCommand(String projenCommand)

Deprecated.

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

Can be used to customize in special environments.

Default: "npx projen"

Parameters:

projenCommand - The shell command to use in order to run the projen CLI. This parameter is required.

Returns:

this

projenrcJson

@Stability(value=Experimental)
public GitHubProject.Builder projenrcJson(Boolean projenrcJson)

Deprecated.

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

Default: false

Parameters:

projenrcJson - Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. This parameter is required.

Returns:

this

projenrcJsonOptions

@Stability(value=Experimental)
public GitHubProject.Builder projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)

Deprecated.

(experimental) Options for .projenrc.json.

Default: - default options

Parameters:

projenrcJsonOptions - Options for .projenrc.json. This parameter is required.

Returns:

this

autoApproveOptions

@Stability(value=Experimental)
public GitHubProject.Builder autoApproveOptions(AutoApproveOptions autoApproveOptions)

Deprecated.

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

Default: - auto approve is disabled

Parameters:

autoApproveOptions - Enable and configure the 'auto approve' workflow. This parameter is required.

Returns:

this

autoMergeOptions

@Stability(value=Experimental)
public GitHubProject.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)

Deprecated.

(experimental) Configure options for automatic merging on GitHub.

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

Default: - see defaults in `AutoMergeOptions`

Parameters:

autoMergeOptions - Configure options for automatic merging on GitHub. This parameter is required.

Returns:

this

clobber

@Stability(value=Experimental)
public GitHubProject.Builder clobber(Boolean clobber)

Deprecated.

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

Default: true

Parameters:

clobber - Add a `clobber` task which resets the repo to origin. This parameter is required.

Returns:

this

devContainer

@Stability(value=Experimental)
public GitHubProject.Builder devContainer(Boolean devContainer)

Deprecated.

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

Default: false

Parameters:

devContainer - Add a VSCode development environment (used for GitHub Codespaces). This parameter is required.

Returns:

this

github

@Stability(value=Experimental)
public GitHubProject.Builder github(Boolean github)

Deprecated.

(experimental) Enable GitHub integration.

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

Default: true

Parameters:

github - Enable GitHub integration. This parameter is required.

Returns:

this

githubOptions

@Stability(value=Experimental)
public GitHubProject.Builder githubOptions(GitHubOptions githubOptions)

Deprecated.

(experimental) Options for GitHub integration.

Default: - see GitHubOptions

Parameters:

githubOptions - Options for GitHub integration. This parameter is required.

Returns:

this

gitpod

@Stability(value=Experimental)
public GitHubProject.Builder gitpod(Boolean gitpod)

Deprecated.

(experimental) Add a Gitpod development environment.

Default: false

Parameters:

gitpod - Add a Gitpod development environment. This parameter is required.

Returns:

this

mergify

@Stability(value=Deprecated)
 @Deprecated
public GitHubProject.Builder mergify(Boolean mergify)

Deprecated. use `githubOptions.mergify` instead

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

Default: true

Parameters:

mergify - Whether mergify should be enabled on this repository or not. This parameter is required.

Returns:

this

mergifyOptions

@Stability(value=Deprecated)
 @Deprecated
public GitHubProject.Builder mergifyOptions(MergifyOptions mergifyOptions)

Deprecated. use `githubOptions.mergifyOptions` instead

(deprecated) Options for mergify.

Default: - default options

Parameters:

mergifyOptions - Options for mergify. This parameter is required.

Returns:

this

projectType

@Stability(value=Deprecated)
 @Deprecated
public GitHubProject.Builder projectType(ProjectType projectType)

Deprecated. no longer supported at the base project level

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

Default: ProjectType.UNKNOWN

Parameters:

projectType - Which type of project this is (library/app). This parameter is required.

Returns:

this

readme

@Stability(value=Experimental)
public GitHubProject.Builder readme(SampleReadmeProps readme)

Deprecated.

(experimental) The README setup.

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

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 "{ filename: 'readme.md', contents: '# title' }"
 

Parameters:

readme - The README setup. This parameter is required.

Returns:

this

stale

@Stability(value=Experimental)
public GitHubProject.Builder stale(Boolean stale)

Deprecated.

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

See staleOptions for options.

Default: true

Parameters:

stale - Auto-close of stale issues and pull request. This parameter is required.

Returns:

this

staleOptions

@Stability(value=Experimental)
public GitHubProject.Builder staleOptions(StaleOptions staleOptions)

Deprecated.

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

To disable set stale to false.

Default: - see defaults in `StaleOptions`

Parameters:

staleOptions - Auto-close stale issues and pull requests. This parameter is required.

Returns:

this

vscode

@Stability(value=Experimental)
public GitHubProject.Builder vscode(Boolean vscode)

Deprecated.

(experimental) Enable VSCode integration.

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

Default: true

Parameters:

vscode - Enable VSCode integration. This parameter is required.

Returns:

this

build

@Stability(value=Deprecated)
 @Deprecated
public GitHubProject build()

Deprecated.

Specified by:

build in interface software.amazon.jsii.Builder<GitHubProject>