Hooks

Alpha

@catapultjs/deploy is currently in alpha. Its API may change between minor releases until it reaches a stable version. Pin the package version in your package.json to avoid unexpected breaking changes during updates.

Hooks are global callbacks that run around the deployment, outside the pipeline.

export default defineConfig({
  // ...
  hooks: {
    async beforeDeploy({ hosts }) {
      console.log(`Deploying to ${hosts!.length} server(s)`)
    },

    async afterDeploy({ hosts }) {
      // runs after all hosts deployed successfully
    },

    async afterFailure({ hosts, error }) {
      console.log(`Deploy failed: ${error?.message}`)
    },

    async beforeHostDeploy({ host }) {
      // enable maintenance mode
    },

    async afterHostDeploy({ host }) {
      // disable maintenance mode
    },
  },
})

Hook	Context	When it runs
beforeDeploy	{ hosts }	Before deploying to all hosts
afterDeploy	{ hosts }	After all hosts deployed successfully
afterFailure	{ hosts, error }	When a deployment fails
beforeHostDeploy	{ host }	Before the pipeline for each host
afterHostDeploy	{ host }	After the pipeline for each host (even on error)