Entire trail trigger

See Entire Triggers for an overview and Event Triggers for generic options like title, target, and if.

By default, the trail trigger runs when a trail is opened, reopened, or updated with a change to its head commit:

on:
  entire:
    trail:
      init:
        commit-sha: ${{ event.git.sha }}
        trail-number: ${{ event.entire.trail.event.payload.trail.number }}

Events without a valid head SHA don't start runs, even when you explicitly select their action. See Cloning Repositories for a complete checkout example.

Actions

Supported actions are opened, updated, reopened, closed, and merged. Use the action name without the trail. prefix:

on:
  entire:
    trail:
      actions: [merged]

Omitting actions handles opened, reopened, and only updated events whose payload includes changes.head_sha.

Event fields

The full webhook payload is available under event.entire.trail. Payload fields are nested under event.entire.trail.event.payload.

PathDescription
event.git.shaThe trail's head commit SHA.
event.git.branchThe trail's source branch, or an empty string when absent.
event.git.refThe source branch ref, such as refs/heads/my-feature, or an empty string when absent.
event.entire.trail.event.typeThe full event type, such as trail.opened or trail.updated.
event.entire.trail.event.payload.trail.idThe trail ID.
event.entire.trail.event.payload.trail.numberThe trail number.
event.entire.trail.event.payload.trail.titleThe trail title.
event.entire.trail.event.payload.trail.stateThe trail state.
event.entire.trail.event.payload.trail.branchThe source branch; may be null.
event.entire.trail.event.payload.trail.baseThe base branch.
event.entire.trail.event.payload.trail.head_shaThe head commit SHA; may be null in events that don't start runs.
event.entire.trail.event.payload.repository.pathThe repository path, in project/repository form.
event.entire.trail.event.payload.repository.entire_clone_urlThe entire:// clone URL.
event.entire.trail.event.payload.actor.account.idThe actor's account ID, when an actor is present.
event.entire.trail.event.payload.changes.head_sha.fromThe previous head SHA, when a head change is present.
event.entire.trail.event.payload.changes.head_sha.toThe new head SHA, when a head change is present.

The optional changes object can also include state, title, branch, and base changes, each with from and to values.