com.github.action.Workflow0.0.5
Properties( )
Methods( )
Classes
-
-
linkclassBranchProtectionRule extends Trigger
Runs your workflow anytime the branch_protection_rule event occurs. More than one activity type triggers this event.
-
-
linkclassCheckSuite extends Trigger
Runs your workflow anytime the check_suite event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/checks/suites/
-
-
-
linkclassDeployment extends Trigger
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. For information about the REST API, see https://developer.github.com/v3/repos/deployments/.
-
linkclassDeploymentStatus extends Trigger
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. For information about the REST API, see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status.
-
linkclassDiscussion extends Trigger
Runs your workflow anytime the discussion event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions
-
linkclassDiscussionComment extends Trigger
Runs your workflow anytime the discussion_comment event occurs. More than one activity type triggers this event. For information about the GraphQL API, see https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions
-
-
-
linkclassIssueComment extends Trigger
Runs your workflow anytime the issue_comment event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/issues/comments/.
-
-
-
linkclassMergeGroup extends Trigger
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.
-
-
-
-
linkclassProjectCard extends Trigger
Runs your workflow anytime the project_card event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/cards.
-
linkclassProjectColumn extends Trigger
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.
-
-
linkclassPullRequest extends Trigger
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.
-
linkclassPullRequestReview extends Trigger
Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls/reviews. 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.
-
linkclassPullRequestReviewComment extends Trigger
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. For information about the REST API, see https://developer.github.com/v3/pulls/comments. 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.
-
linkclassPullRequestTarget extends Trigger
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.
-
linkclass
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.
-
linkclassRegistryPackage extends Trigger
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
-
-
linkclassRepositoryDispatch extends Trigger
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.
-
linkclass
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).
-
-
-
-
-
-
linkclassWorkflowDispatch extends Trigger
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.
-
-
linkclassWorkflowRun extends Trigger
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
Type Aliases
-
-
-
-
linktypealiasDiscussionType = "created"|"edited"|"deleted"|"transferred"|"pinned"|"unpinned"|"labeled"|"unlabeled"|"locked"|"unlocked"|"category_changed"|"answered"|"unanswered"
-
-
-
linktypealiasIssuesType = "opened"|"edited"|"deleted"|"transferred"|"pinned"|"unpinned"|"closed"|"reopened"|"assigned"|"unassigned"|"labeled"|"unlabeled"|"locked"|"unlocked"|"milestoned"|"demilestoned"
-
-
-
-
-
-
-
linktypealiasPullRequestType = "assigned"|"unassigned"|"review_requested"|"review_request_removed"|"labeled"|"unlabeled"|"opened"|"edited"|"closed"|"reopened"|"synchronize"|"ready_for_review"|"locked"|"unlocked"|"converted_to_draft"|"demilestoned"|"milestoned"|"auto_merge_enabled"|"auto_merge_disabled"
-
-
-
linktypealiasPullRequestTargetType = "assigned"|"unassigned"|"labeled"|"unlabeled"|"opened"|"edited"|"closed"|"reopened"|"synchronize"|"converted_to_draft"|"ready_for_review"|"locked"|"unlocked"|"review_requested"|"review_request_removed"|"auto_merge_enabled"|"auto_merge_disabled"
-
-
linktypealiasReleaseType = "published"|"unpublished"|"created"|"edited"|"deleted"|"prereleased"|"released"
-
-
-
-
-
-
-
-
A Pkl template for writing GitHub Action workflows.