Skip to content

Build manifest #2312

@pi0

Description

@pi0

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions