Package io.github.cdklabs.projen.github

Class GitHubProject

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Project

io.github.cdklabs.projen.github.GitHubProject

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

JavaProject, NodeProject, PythonProject

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.071Z")
@Stability(Deprecated)
@Deprecated
public class GitHubProject
extends Project

Deprecated.

This is a temporary class. At the moment, our base project types such as NodeProject and JavaProject are derived from this, but we want to be able to use these project types outside of GitHub as well. One of the next steps to address this is to abstract workflows so that different "engines" can be used to implement our CI/CD solutions.

(deprecated) GitHub-based project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GitHubProject.Builder	Deprecated.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Field Summary

Fields inherited from class io.github.cdklabs.projen.Project

DEFAULT_TASK

Constructor Summary

Constructors

Modifier	Constructor	Description
	GitHubProject(GitHubProjectOptions options)	Deprecated.
protected	GitHubProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)	Deprecated.
protected	GitHubProject(software.amazon.jsii.JsiiObjectRef objRef)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	annotateGenerated(String glob)	Deprecated.
AutoApprove	getAutoApprove()	Deprecated.
DevContainer	getDevContainer()	Deprecated.
GitHub	getGithub()	Deprecated.
Gitpod	getGitpod()	Deprecated.
ProjectType	getProjectType()	Deprecated.
VsCode	getVscode()	Deprecated.

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

addExcludeFromCleanup, addGitIgnore, addPackageIgnore, addTask, addTask, addTip, getBuildTask, getCommitGenerated, getCompileTask, getComponents, getDefaultTask, getDeps, getEjected, getFiles, getGitattributes, getGitignore, getInitProject, getLogger, getName, getOutdir, getPackageTask, getParent, getPostCompileTask, getPreCompileTask, getProjectBuild, getProjenCommand, getRoot, getSubprojects, getTasks, getTestTask, isProject, of, postSynthesize, preSynthesize, removeTask, runTaskCommand, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile, tryRemoveFile

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

GitHubProject

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

Deprecated.

GitHubProject

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

Deprecated.

GitHubProject

@Stability(Deprecated)
@Deprecated
public GitHubProject(@NotNull
                     GitHubProjectOptions options)

Deprecated.

Parameters:

options - This parameter is required.

Method Detail

annotateGenerated

@Stability(Deprecated)
@Deprecated
public void annotateGenerated(@NotNull
                              String glob)

Deprecated.

(deprecated) Marks the provided file(s) as being generated.

This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.

Overrides:

annotateGenerated in class Project

Parameters:

glob - the glob pattern to match (could be a file path). This parameter is required.

See Also:

https://github.com/github/linguist/blob/master/docs/overrides.md

getProjectType

@Stability(Deprecated)
@Deprecated
@NotNull
public ProjectType getProjectType()

Deprecated.

getAutoApprove

@Stability(Deprecated)
@Deprecated
@Nullable
public AutoApprove getAutoApprove()

Deprecated.

(deprecated) Auto approve set up for this project.

getDevContainer

@Stability(Deprecated)
@Deprecated
@Nullable
public DevContainer getDevContainer()

Deprecated.

(deprecated) Access for .devcontainer.json (used for GitHub Codespaces).

This will be undefined if devContainer boolean is false

getGithub

@Stability(Deprecated)
@Deprecated
@Nullable
public GitHub getGithub()

Deprecated.

(deprecated) Access all github components.

This will be undefined for subprojects.

getGitpod

@Stability(Deprecated)
@Deprecated
@Nullable
public Gitpod getGitpod()

Deprecated.

(deprecated) Access for Gitpod.

This will be undefined if gitpod boolean is false

getVscode

@Stability(Deprecated)
@Deprecated
@Nullable
public VsCode getVscode()

Deprecated.

(deprecated) Access all VSCode components.

This will be undefined for subprojects.