Ready Hook

Learn what are ready hooks in MergeQueue and how they work. User-defined ready hooks can execute custom JavaScript code to control MergeQueue behavior.

MergeQueue supports user-defined ready hooks which can execute custom JavaScript code to finely control how MergeQueue behaves.

The ready hook is executed once whenever a pull request is marked as ready-to-merge (usually via adding the repository's configured label, by using a slash command, or using the Aviator API).

The ready hook is defined by creating a file in your GitHub repository at .aviator/mergequeue/ready.js and should define a function ready that will be called by the Pilot JavaScript runtime.

See how you can use Ready Hook to reduce queue failures due to staleness.