github.github.onpush

Home > @runlightyear/github > GitHub > onPush

GitHub.onPush() method

This event occurs when a commit or tag is pushed.

Note: An event will not be created when more than three tags are pushed at once.

Signature:

static onPush(props: GitHubListenerProps<PushPayload>): {
        webhook: string;
        action: string;
    };

Parameters

Parameter	Type	Description
props	GitHubListenerProps<PushPayload>

Returns:

{ webhook: string; action: string; }

Example

On push

import { GitHub } from "@runlightyear/github";

GitHub.onPush({
  name: "onPush",
  title: "On Push",
  run: async ({ data, auths }) => {
    console.log("Push data: ", data);
  },
});