nitrojs / nitrojs/nitro

Build manifest

Open
#2,312 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

discussion enhancement v2
Dominant language
TypeScript
Stars
11.2k
Forks
899
Avg merge
2d 24m
Merged PRs (30d)
40

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by mapping the build context, runtime config, server manifest at .output/nitro.json, and optional public manifest under .output/public/_nitro/builds/. Review how Nitro options and deployment-provider environment variables are exposed, then define the manifest behavior across the listed contexts. Done means the requested build ID, deployment ID, and timestamp are consistently available through the unified API.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
backend, build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.