nitro icon indicating copy to clipboard operation
nitro copied to clipboard

Build manifest

Open pi0 opened this issue 3 months ago • 0 comments

When building Nitro-based projects, we can gather information about build/deployment and make it universally accessible with a unified API across deployment providers.

  • manifest.buildId: Auto-generated during the build
  • manifest.deploymentId: Can be set by the deployment provider (usually env variables)
  • manifest.timestampt: Time when the build started

It can be accessible in different contexts:

  • Via build-context using nitro.options.manifest.{buildId, deploymentId}
  • Via runtime config (useRuntimeConfig().nitro.manifest)
  • Via server build manifest file (.output/nitro.json)
  • Via an opt-in/customizable public manifest (.output/public/_nitro/builds/{buildId}.json) similar to Nuxt app manifest

It can be used for several purposes both for custom deployments but mainly for gracefully handling new deployments or provider-specific logic like vercel skew protection

pi0 avatar Mar 25 '24 18:03 pi0