Pkldoc > com.github.action > com.github.action.Workflow

On0.0.6

Properties
Methods

class On

Known subtypes:
Known usages:
All versions:

Properties

link

branch_protection_rule: BranchProtectionRule?

Runs your workflow anytime the branch_protection_rule event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#branch_protection_rule
link

check_run: CheckRun?

Runs your workflow anytime the check_run event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#check_run
link

check_suite: CheckSuite?

Runs your workflow anytime the check_suite event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#check_suite
link

create: BaseTrigger?

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

For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#create
link

`delete`: BaseTrigger?

Runs your workflow when someone deletes a Git reference (Git branch or tag) in the workflow's repository.

For information about the APIs to delete a Git reference, see Mutations in the GraphQL API documentation or REST API endpoints for Git references.

See https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#delete
link

deployment: BaseTrigger?

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.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#deployment
link

deployment_status: BaseTrigger?

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.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#deployment_status
link

discussion: Discussion?

Runs your workflow anytime the discussion event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#discussion
link

discussion_comment: DiscussionComment?

Runs your workflow anytime the discussion_comment event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#discussion_comment
link

fork: BaseTrigger?

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

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#fork
link

gollum: BaseTrigger?

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

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#gollum
link

issue_comment: IssueComment?

Runs your workflow anytime the issue_comment event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment
link

issues: Issues?

Runs your workflow anytime the issues event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues
link

label: Label?

Runs your workflow anytime the label event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#label
link

merge_group: MergeGroup?

Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group.

For information about the merge queue, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.

See https://help.github.com/en/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows#merge_group
link

milestone: Milestone?

Runs your workflow anytime the milestone event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#milestone
link

page_build: BaseTrigger?

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

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#page_build
link

project: Project?

Runs your workflow anytime the project event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#project
link

project_card: ProjectCard?

Runs your workflow anytime the project_card event occurs.

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#project_card
link

project_column: ProjectColumn?

Runs your workflow anytime the project_column event occurs.

More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/columns.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#project_column
link

public: BaseTrigger?

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

For information about the REST API, see https://developer.github.com/v3/repos/#edit.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#public
link

pull_request: PullRequest?

Runs your workflow anytime the pull_request event occurs.

More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls.

Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
link

pull_request_review: PullRequestReview?

Runs your workflow anytime the pull_request_review event occurs.

More than one activity type triggers this event.

Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository. Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository. The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_review
link

pull_request_review_comment: PullRequestReviewComment?

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

More than one activity type triggers this event.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_review_comment
link

pull_request_target: PullRequest?

This event is similar to pull_request, except that it runs in the context of the base repository of the pull request, rather than in the merge commit.

This means that you can more safely make your secrets available to the workflows triggered by the pull request, because only workflows defined in the commit on the base repository are run.

For example, this event allows you to create workflows that label and comment on pull requests, based on the contents of the event payload.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
link

push: Push?

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

Note: The webhook payload available to GitHub Actions does not include the added, removed, and modified attributes in the commit object. You can retrieve the full commit object using the REST API. For more information, see https://developer.github.com/v3/repos/commits/#get-a-single-commit.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push
link

registry_package: RegistryPackage?

Runs your workflow anytime a package is published or updated.

For more information, see https://help.github.com/en/github/managing-packages-with-github-packages.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#registry_package
link

release: Release?

Runs your workflow anytime the release event occurs.

More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/releases/ in the GitHub Developer documentation.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
link

repository_dispatch: RepositoryDispatch?

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.

For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event. To trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event.

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#repository_dispatch
link

schedule: Listing<Schedule>?

You can schedule a workflow to run at specific UTC times using POSIX cron syntax (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07).

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. Note: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot. You can use crontab guru (https://crontab.guru/) to help generate your cron syntax and confirm what time it will run. To help you get started, there is also a list of crontab guru examples (https://crontab.guru/examples.html).

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#schedule
link

status: BaseTrigger?

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

For information about the REST API, see https://developer.github.com/v3/repos/statuses/.

See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#status
link

watch: BaseTrigger?

Runs your workflow anytime the watch event occurs.

More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/activity/starring/

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#watch
link

workflow_call: WorkflowCall?

Allows workflows to be reused by other workflows.

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_call
link

workflow_dispatch: WorkflowDispatch?

You can now create workflows that are manually triggered with the new workflow_dispatch event.

You will then see a 'Run workflow' button on the Actions tab, enabling you to easily trigger a run.

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch
link

workflow_run: WorkflowRun?

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.

For example, if your pull_request workflow generates build artifacts, you can create a new workflow that uses workflow_run to analyze the results and add a comment to the original pull request.

See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_run

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.