io.github.cdklabs.projen.github.workflows

Interface Triggers

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Triggers.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.792Z")
 @Stability(value=Experimental)
public interface Triggers
extends software.amazon.jsii.JsiiSerializable

(experimental) The set of available triggers for GitHub Workflows.

See Also:

https://docs.github.com/en/actions/reference/events-that-trigger-workflows

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Triggers.Builder A builder for Triggers
static class	Triggers.Jsii$Proxy An implementation for Triggers

Method Summary

Modifier and Type	Method and Description
static Triggers.Builder	builder()
default BranchProtectionRuleOptions	getBranchProtectionRule() (experimental) Runs your workflow anytime the branch_protection_rule event occurs.
default CheckRunOptions	getCheckRun() (experimental) Runs your workflow anytime the check_run event occurs.
default CheckSuiteOptions	getCheckSuite() (experimental) Runs your workflow anytime the check_suite event occurs.
default CreateOptions	getCreate() (experimental) Runs your workflow anytime someone creates a branch or tag, which triggers the create event.
default DeleteOptions	getDelete() (experimental) Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event.
default DeploymentOptions	getDeployment() (experimental) Runs your workflow anytime someone creates a deployment, which triggers the deployment event.
default DeploymentStatusOptions	getDeploymentStatus() (experimental) Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event.
default DiscussionOptions	getDiscussion() (experimental) Runs your workflow anytime the discussion event occurs.
default DiscussionCommentOptions	getDiscussionComment() (experimental) Runs your workflow anytime the discussion_comment event occurs.
default ForkOptions	getFork() (experimental) Runs your workflow anytime when someone forks a repository, which triggers the fork event.
default GollumOptions	getGollum() (experimental) Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.
default IssueCommentOptions	getIssueComment() (experimental) Runs your workflow anytime the issue_comment event occurs.
default IssuesOptions	getIssues() (experimental) Runs your workflow anytime the issues event occurs.
default LabelOptions	getLabel() (experimental) Runs your workflow anytime the label event occurs.
default MilestoneOptions	getMilestone() (experimental) Runs your workflow anytime the milestone event occurs.
default PageBuildOptions	getPageBuild() (experimental) Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event.
default ProjectOptions	getProject() (experimental) Runs your workflow anytime the project event occurs.
default ProjectCardOptions	getProjectCard() (experimental) Runs your workflow anytime the project_card event occurs.
default ProjectColumnOptions	getProjectColumn() (experimental) Runs your workflow anytime the project_column event occurs.
default PublicOptions	getPublicValue() (experimental) Runs your workflow anytime someone makes a private repository public, which triggers the public event.
default PullRequestOptions	getPullRequest() (experimental) Runs your workflow anytime the pull_request event occurs.
default PullRequestReviewOptions	getPullRequestReview() (experimental) Runs your workflow anytime the pull_request_review event occurs.
default PullRequestReviewCommentOptions	getPullRequestReviewComment() (experimental) Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event.
default PullRequestTargetOptions	getPullRequestTarget() (experimental) This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does.
default PushOptions	getPush() (experimental) Runs your workflow when someone pushes to a repository branch, which triggers the push event.
default RegistryPackageOptions	getRegistryPackage() (experimental) Runs your workflow anytime a package is published or updated.
default ReleaseOptions	getRelease() (experimental) Runs your workflow anytime the release event occurs.
default RepositoryDispatchOptions	getRepositoryDispatch() (experimental) You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub.
default List<CronScheduleOptions>	getSchedule() (experimental) You can schedule a workflow to run at specific UTC times using POSIX cron syntax.
default StatusOptions	getStatus() (experimental) Runs your workflow anytime the status of a Git commit changes, which triggers the status event.
default WatchOptions	getWatch() (experimental) Runs your workflow anytime the watch event occurs.
default WorkflowCallOptions	getWorkflowCall() (experimental) Can be called from another workflow.
default WorkflowDispatchOptions	getWorkflowDispatch() (experimental) You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow.
default WorkflowRunOptions	getWorkflowRun() (experimental) This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBranchProtectionRule

@Stability(value=Experimental)
 @Nullable
default BranchProtectionRuleOptions getBranchProtectionRule()

(experimental) Runs your workflow anytime the branch_protection_rule event occurs.

getCheckRun

@Stability(value=Experimental)
 @Nullable
default CheckRunOptions getCheckRun()

(experimental) Runs your workflow anytime the check_run event occurs.

getCheckSuite

@Stability(value=Experimental)
 @Nullable
default CheckSuiteOptions getCheckSuite()

(experimental) Runs your workflow anytime the check_suite event occurs.

getCreate

@Stability(value=Experimental)
 @Nullable
default CreateOptions getCreate()

(experimental) Runs your workflow anytime someone creates a branch or tag, which triggers the create event.

getDelete

@Stability(value=Experimental)
 @Nullable
default DeleteOptions getDelete()

(experimental) Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event.

getDeployment

@Stability(value=Experimental)
 @Nullable
default DeploymentOptions getDeployment()

(experimental) Runs your workflow anytime someone creates a deployment, which triggers the deployment event.

Deployments created with a commit SHA may not have a Git ref.

getDeploymentStatus

@Stability(value=Experimental)
 @Nullable
default DeploymentStatusOptions getDeploymentStatus()

(experimental) Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event.

Deployments created with a commit SHA may not have a Git ref.

getDiscussion

@Stability(value=Experimental)
 @Nullable
default DiscussionOptions getDiscussion()

(experimental) Runs your workflow anytime the discussion event occurs.

More than one activity type triggers this event.

See Also:

https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions

getDiscussionComment

@Stability(value=Experimental)
 @Nullable
default DiscussionCommentOptions getDiscussionComment()

(experimental) Runs your workflow anytime the discussion_comment event occurs.

More than one activity type triggers this event.

See Also:

https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions

getFork

@Stability(value=Experimental)
 @Nullable
default ForkOptions getFork()

(experimental) Runs your workflow anytime when someone forks a repository, which triggers the fork event.

getGollum

@Stability(value=Experimental)
 @Nullable
default GollumOptions getGollum()

(experimental) Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.

getIssueComment

@Stability(value=Experimental)
 @Nullable
default IssueCommentOptions getIssueComment()

(experimental) Runs your workflow anytime the issue_comment event occurs.

getIssues

@Stability(value=Experimental)
 @Nullable
default IssuesOptions getIssues()

(experimental) Runs your workflow anytime the issues event occurs.

getLabel

@Stability(value=Experimental)
 @Nullable
default LabelOptions getLabel()

(experimental) Runs your workflow anytime the label event occurs.

getMilestone

@Stability(value=Experimental)
 @Nullable
default MilestoneOptions getMilestone()

(experimental) Runs your workflow anytime the milestone event occurs.

getPageBuild

@Stability(value=Experimental)
 @Nullable
default PageBuildOptions getPageBuild()

(experimental) Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event.

getProject

@Stability(value=Experimental)
 @Nullable
default ProjectOptions getProject()

(experimental) Runs your workflow anytime the project event occurs.

getProjectCard

@Stability(value=Experimental)
 @Nullable
default ProjectCardOptions getProjectCard()

(experimental) Runs your workflow anytime the project_card event occurs.

getProjectColumn

@Stability(value=Experimental)
 @Nullable
default ProjectColumnOptions getProjectColumn()

(experimental) Runs your workflow anytime the project_column event occurs.

getPublicValue

@Stability(value=Experimental)
 @Nullable
default PublicOptions getPublicValue()

(experimental) Runs your workflow anytime someone makes a private repository public, which triggers the public event.

getPullRequest

@Stability(value=Experimental)
 @Nullable
default PullRequestOptions getPullRequest()

(experimental) Runs your workflow anytime the pull_request event occurs.

getPullRequestReview

@Stability(value=Experimental)
 @Nullable
default PullRequestReviewOptions getPullRequestReview()

(experimental) Runs your workflow anytime the pull_request_review event occurs.

getPullRequestReviewComment

@Stability(value=Experimental)
 @Nullable
default PullRequestReviewCommentOptions getPullRequestReviewComment()

(experimental) Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event.

getPullRequestTarget

@Stability(value=Experimental)
 @Nullable
default PullRequestTargetOptions getPullRequestTarget()

(experimental) This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does.

This prevents executing unsafe workflow code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows you to do things like create workflows that label and comment on pull requests based on the contents of the event payload.

WARNING: The pull_request_target event is granted read/write repository token and can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch, and to help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered.

See Also:

https://securitylab.github.com/research/github-actions-preventing-pwn-requests

getPush

@Stability(value=Experimental)
 @Nullable
default PushOptions getPush()

(experimental) Runs your workflow when someone pushes to a repository branch, which triggers the push event.

getRegistryPackage

@Stability(value=Experimental)
 @Nullable
default RegistryPackageOptions getRegistryPackage()

(experimental) Runs your workflow anytime a package is published or updated.

getRelease

@Stability(value=Experimental)
 @Nullable
default ReleaseOptions getRelease()

(experimental) Runs your workflow anytime the release event occurs.

getRepositoryDispatch

@Stability(value=Experimental)
 @Nullable
default RepositoryDispatchOptions getRepositoryDispatch()

(experimental) You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub.

getSchedule

@Stability(value=Experimental)
 @Nullable
default List<CronScheduleOptions> getSchedule()

(experimental) You can schedule a workflow to run at specific UTC times using POSIX cron syntax.

Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes.

See Also:

https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07

getStatus

@Stability(value=Experimental)
 @Nullable
default StatusOptions getStatus()

(experimental) Runs your workflow anytime the status of a Git commit changes, which triggers the status event.

getWatch

@Stability(value=Experimental)
 @Nullable
default WatchOptions getWatch()

(experimental) Runs your workflow anytime the watch event occurs.

getWorkflowCall

@Stability(value=Experimental)
 @Nullable
default WorkflowCallOptions getWorkflowCall()

(experimental) Can be called from another workflow.

See Also:

https://docs.github.com/en/actions/learn-github-actions/reusing-workflows

getWorkflowDispatch

@Stability(value=Experimental)
 @Nullable
default WorkflowDispatchOptions getWorkflowDispatch()

(experimental) You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow.

When the workflow runs, you can access the input values in the github.event.inputs context.

getWorkflowRun

@Stability(value=Experimental)
 @Nullable
default WorkflowRunOptions getWorkflowRun()

(experimental) This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow.

A workflow run is triggered regardless of the result of the previous workflow.

builder

@Stability(value=Experimental)
static Triggers.Builder builder()

Returns:

a Triggers.Builder of Triggers