Package io.github.cdklabs.projen.github

Interface Summary

Interface	Description
AutoApproveOptions	(experimental) Options for 'AutoApprove'.
AutoMergeOptions
CheckoutOptions
CheckoutWith	(experimental) Options for checkout.
CheckoutWithPatchOptions	(experimental) Options for checkoutWithPatch.
ContributorStatementOptions	(experimental) Options for requiring a contributor statement on Pull Requests.
CreatePullRequestOptions
DependabotAllow	(experimental) You can use the allow option to customize which dependencies are updated.
DependabotGroup	(experimental) Defines a single group for dependency updates.
DependabotIgnore	(experimental) You can use the ignore option to customize which dependencies are updated.
DependabotOptions
DependabotRegistry	(experimental) Use to add private registry support for dependabot.
DownloadArtifactOptions
DownloadArtifactWith
GithubCredentialsAppOptions	(experimental) Options for GithubCredentials.fromApp.
GithubCredentialsPersonalAccessTokenOptions	(experimental) Options for GithubCredentials.fromPersonalAccessToken.
GitHubOptions
GitHubProjectOptions	(experimental) Options for GitHubProject.
GithubWorkflowOptions	(experimental) Options for GithubWorkflow.
GitIdentity	(experimental) Represents the git identity.
IAddConditionsLater
IAddConditionsLater.Jsii$Default	Internal default implementation for IAddConditionsLater.
MergifyConditionalOperator	(experimental) The Mergify conditional operators that can be used are: or and and.
MergifyOptions
MergifyQueue
MergifyRule
PullRequestFromPatchOptions
PullRequestLintOptions	(experimental) Options for PullRequestLint.
PullRequestPatchSource
PullRequestTemplateOptions	(experimental) Options for PullRequestTemplate.
SemanticTitleOptions	(experimental) Options for linting that PR titles follow Conventional Commits.
SetupGitIdentityOptions
StaleBehavior	(experimental) Stale behavior.
StaleOptions	(experimental) Options for Stale.
TaskWorkflowJobOptions	(experimental) Options to create the Job associated with a TaskWorkflow.
TaskWorkflowOptions	(experimental) Options to create a TaskWorkflow.
UploadArtifactOptions
UploadArtifactWith
UploadGitPatchOptions	(experimental) Options for uploadGitPatch.

Class Summary

Class	Description
AutoApprove	(experimental) Auto approve pull requests that meet a criteria.
AutoApprove.Builder	(experimental) A fluent builder for AutoApprove.
AutoApproveOptions.Builder	A builder for AutoApproveOptions
AutoApproveOptions.Jsii$Proxy	An implementation for AutoApproveOptions
AutoMerge	(experimental) Sets up mergify to merging approved pull requests.
AutoMerge.Builder	(experimental) A fluent builder for AutoMerge.
AutoMergeOptions.Builder	A builder for AutoMergeOptions
AutoMergeOptions.Jsii$Proxy	An implementation for AutoMergeOptions
CheckoutOptions.Builder	A builder for CheckoutOptions
CheckoutOptions.Jsii$Proxy	An implementation for CheckoutOptions
CheckoutWith.Builder	A builder for CheckoutWith
CheckoutWith.Jsii$Proxy	An implementation for CheckoutWith
CheckoutWithPatchOptions.Builder	A builder for CheckoutWithPatchOptions
CheckoutWithPatchOptions.Jsii$Proxy	An implementation for CheckoutWithPatchOptions
ContributorStatementOptions.Builder	A builder for ContributorStatementOptions
ContributorStatementOptions.Jsii$Proxy	An implementation for ContributorStatementOptions
CreatePullRequestOptions.Builder	A builder for CreatePullRequestOptions
CreatePullRequestOptions.Jsii$Proxy	An implementation for CreatePullRequestOptions
Dependabot	(experimental) Defines dependabot configuration for node projects.
Dependabot.Builder	(experimental) A fluent builder for Dependabot.
DependabotAllow.Builder	A builder for DependabotAllow
DependabotAllow.Jsii$Proxy	An implementation for DependabotAllow
DependabotGroup.Builder	A builder for DependabotGroup
DependabotGroup.Jsii$Proxy	An implementation for DependabotGroup
DependabotIgnore.Builder	A builder for DependabotIgnore
DependabotIgnore.Jsii$Proxy	An implementation for DependabotIgnore
DependabotOptions.Builder	A builder for DependabotOptions
DependabotOptions.Jsii$Proxy	An implementation for DependabotOptions
DependabotRegistry.Builder	A builder for DependabotRegistry
DependabotRegistry.Jsii$Proxy	An implementation for DependabotRegistry
DownloadArtifactOptions.Builder	A builder for DownloadArtifactOptions
DownloadArtifactOptions.Jsii$Proxy	An implementation for DownloadArtifactOptions
DownloadArtifactWith.Builder	A builder for DownloadArtifactWith
DownloadArtifactWith.Jsii$Proxy	An implementation for DownloadArtifactWith
GitHub
GitHub.Builder	(experimental) A fluent builder for GitHub.
GitHubActionsProvider	(experimental) Manage the versions used for GitHub Actions used in steps.
GithubCredentials	(experimental) Represents a method of providing GitHub API access for projen workflows.
GithubCredentialsAppOptions.Builder	A builder for GithubCredentialsAppOptions
GithubCredentialsAppOptions.Jsii$Proxy	An implementation for GithubCredentialsAppOptions
GithubCredentialsPersonalAccessTokenOptions.Builder	A builder for GithubCredentialsPersonalAccessTokenOptions
GithubCredentialsPersonalAccessTokenOptions.Jsii$Proxy	An implementation for GithubCredentialsPersonalAccessTokenOptions
GitHubOptions.Builder	A builder for GitHubOptions
GitHubOptions.Jsii$Proxy	An implementation for GitHubOptions
GitHubProject	Deprecated. This is a temporary class.
GitHubProject.Builder	Deprecated.
GitHubProjectOptions.Builder	A builder for GitHubProjectOptions
GitHubProjectOptions.Jsii$Proxy	An implementation for GitHubProjectOptions
GithubWorkflow	(experimental) Workflow for GitHub.
GithubWorkflow.Builder	(experimental) A fluent builder for GithubWorkflow.
GithubWorkflowOptions.Builder	A builder for GithubWorkflowOptions
GithubWorkflowOptions.Jsii$Proxy	An implementation for GithubWorkflowOptions
GitIdentity.Builder	A builder for GitIdentity
GitIdentity.Jsii$Proxy	An implementation for GitIdentity
IAddConditionsLater.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
Mergify
Mergify.Builder	(experimental) A fluent builder for Mergify.
MergifyConditionalOperator.Builder	A builder for MergifyConditionalOperator
MergifyConditionalOperator.Jsii$Proxy	An implementation for MergifyConditionalOperator
MergifyOptions.Builder	A builder for MergifyOptions
MergifyOptions.Jsii$Proxy	An implementation for MergifyOptions
MergifyQueue.Builder	A builder for MergifyQueue
MergifyQueue.Jsii$Proxy	An implementation for MergifyQueue
MergifyRule.Builder	A builder for MergifyRule
MergifyRule.Jsii$Proxy	An implementation for MergifyRule
PullRequestFromPatchOptions.Builder	A builder for PullRequestFromPatchOptions
PullRequestFromPatchOptions.Jsii$Proxy	An implementation for PullRequestFromPatchOptions
PullRequestLint	(experimental) Configure validations to run on GitHub pull requests.
PullRequestLint.Builder	(experimental) A fluent builder for PullRequestLint.
PullRequestLintOptions.Builder	A builder for PullRequestLintOptions
PullRequestLintOptions.Jsii$Proxy	An implementation for PullRequestLintOptions
PullRequestPatchSource.Builder	A builder for PullRequestPatchSource
PullRequestPatchSource.Jsii$Proxy	An implementation for PullRequestPatchSource
PullRequestTemplate	(experimental) Template for GitHub pull requests.
PullRequestTemplate.Builder	(experimental) A fluent builder for PullRequestTemplate.
PullRequestTemplateOptions.Builder	A builder for PullRequestTemplateOptions
PullRequestTemplateOptions.Jsii$Proxy	An implementation for PullRequestTemplateOptions
SemanticTitleOptions.Builder	A builder for SemanticTitleOptions
SemanticTitleOptions.Jsii$Proxy	An implementation for SemanticTitleOptions
SetupGitIdentityOptions.Builder	A builder for SetupGitIdentityOptions
SetupGitIdentityOptions.Jsii$Proxy	An implementation for SetupGitIdentityOptions
Stale	(experimental) Warns and then closes issues and PRs that have had no activity for a specified amount of time.
Stale.Builder	(experimental) A fluent builder for Stale.
StaleBehavior.Builder	A builder for StaleBehavior
StaleBehavior.Jsii$Proxy	An implementation for StaleBehavior
StaleOptions.Builder	A builder for StaleOptions
StaleOptions.Jsii$Proxy	An implementation for StaleOptions
TaskWorkflow	(experimental) A GitHub workflow for common build tasks within a project.
TaskWorkflow.Builder	(experimental) A fluent builder for TaskWorkflow.
TaskWorkflowJob	(experimental) The primary or initial job of a TaskWorkflow.
TaskWorkflowJob.Builder	(experimental) A fluent builder for TaskWorkflowJob.
TaskWorkflowJobOptions.Builder	A builder for TaskWorkflowJobOptions
TaskWorkflowJobOptions.Jsii$Proxy	An implementation for TaskWorkflowJobOptions
TaskWorkflowOptions.Builder	A builder for TaskWorkflowOptions
TaskWorkflowOptions.Jsii$Proxy	An implementation for TaskWorkflowOptions
UploadArtifactOptions.Builder	A builder for UploadArtifactOptions
UploadArtifactOptions.Jsii$Proxy	An implementation for UploadArtifactOptions
UploadArtifactWith.Builder	A builder for UploadArtifactWith
UploadArtifactWith.Jsii$Proxy	An implementation for UploadArtifactWith
UploadGitPatchOptions.Builder	A builder for UploadGitPatchOptions
UploadGitPatchOptions.Jsii$Proxy	An implementation for UploadGitPatchOptions
WorkflowActions	(experimental) A set of utility functions for creating GitHub actions in workflows.
WorkflowJobs	(experimental) A set of utility functions for creating jobs in GitHub Workflows.
WorkflowSteps	(experimental) A collection of very commonly used, individual, GitHub Workflow Job steps.

Enum Summary

Enum	Description
DependabotRegistryType	(experimental) Each configuration type requires you to provide particular settings.
DependabotScheduleInterval	(experimental) How often to check for new versions and raise pull requests for version updates.
VersioningStrategy	(experimental) The strategy to use when edits manifest and lock files.