GitHub Triggers

RWX can trigger runs based on GitHub events. Before configuring triggers, ensure you've followed the getting started with GitHub guide.

For generic trigger options like title, target, if, and start, see Event Triggers.

Push Triggers

Placing the following snippet at the top of an RWX file will result in all tasks in the file running on every GitHub push.

on:
  github:
    push:

For detailed documentation including event fields and merge group support, see GitHub Push Trigger Reference.

Pull Request Triggers

Placing the following snippet at the top of an RWX file will result in all tasks in the file running any time a GitHub pull request is opened, reopened, or updated.

on:
  github:
    pull_request:

For detailed documentation including event fields and available actions, see GitHub Pull Request Trigger Reference.

Common Patterns

It's common to pass values from the event as init parameters into tasks.

on:
  github:
    push:
      init:
        commit-sha: ${{ event.git.sha }}

base:
  image: ubuntu:24.04
  config: rwx/base 1.0.0

tasks:
  - key: code
    call: git/clone 2.0.3
    with:
      repository: https://github.com/YOUR_ORG/PROJECT.git
      ref: ${{ init.commit-sha }}
      github-token: ${{ github.token }}

Reference Pages