io.github.cdklabs.projen.github

Class GitHub

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.github.GitHub

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.760Z")
 @Stability(value=Experimental)
public class GitHub
extends Component

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitHub.Builder (experimental) A fluent builder for GitHub.

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GitHub(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	GitHub(software.amazon.jsii.JsiiObjectRef objRef)
	GitHub(Project project)
	GitHub(Project project, GitHubOptions options)

Method Summary

Modifier and Type	Method and Description
Dependabot	addDependabot()
Dependabot	addDependabot(DependabotOptions options)
PullRequestTemplate	addPullRequestTemplate(String... content)
GithubWorkflow	addWorkflow(String name) (experimental) Adds a workflow to the project.
Mergify	getMergify() (experimental) The `Mergify` configured on this repository.
List<GithubWorkflow>	getWorkflows() (experimental) All workflows.
Boolean	getWorkflowsEnabled() (experimental) Are workflows enabled?
GithubWorkflow	tryFindWorkflow(String name) (experimental) Finds a GitHub workflow by name.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, postSynthesize, preSynthesize, synthesize

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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

GitHub

protected GitHub(software.amazon.jsii.JsiiObjectRef objRef)

GitHub

protected GitHub(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

GitHub

@Stability(value=Experimental)
public GitHub(@NotNull
                                             Project project,
                                             @Nullable
                                             GitHubOptions options)

Parameters:

project - This parameter is required.

options -

GitHub

@Stability(value=Experimental)
public GitHub(@NotNull
                                             Project project)

Parameters:

project - This parameter is required.

Method Detail

addDependabot

@Stability(value=Experimental)
 @NotNull
public Dependabot addDependabot(@Nullable
                                                                         DependabotOptions options)

Parameters:

options -

addDependabot

@Stability(value=Experimental)
 @NotNull
public Dependabot addDependabot()

addPullRequestTemplate

@Stability(value=Experimental)
 @NotNull
public PullRequestTemplate addPullRequestTemplate(@NotNull
                                                                                           String... content)

Parameters:

content - This parameter is required.

addWorkflow

@Stability(value=Experimental)
 @NotNull
public GithubWorkflow addWorkflow(@NotNull
                                                                           String name)

(experimental) Adds a workflow to the project.

Parameters:

name - Name of the workflow. This parameter is required.

Returns:

a GithubWorkflow instance

tryFindWorkflow

@Stability(value=Experimental)
 @Nullable
public GithubWorkflow tryFindWorkflow(@NotNull
                                                                                String name)

(experimental) Finds a GitHub workflow by name.

Returns undefined if the workflow cannot be found.

Parameters:

name - The name of the GitHub workflow. This parameter is required.

getWorkflows

@Stability(value=Experimental)
 @NotNull
public List<GithubWorkflow> getWorkflows()

(experimental) All workflows.

getWorkflowsEnabled

@Stability(value=Experimental)
 @NotNull
public Boolean getWorkflowsEnabled()

(experimental) Are workflows enabled?

getMergify

@Stability(value=Experimental)
 @Nullable
public Mergify getMergify()

(experimental) The `Mergify` configured on this repository.

This is undefined if Mergify was not enabled when creating the repository.