NevermoreCliManifest

Manifest of nevermore CLI-injected deploy metadata (commit, target, version, timestamp)

Installation

npm install @quenty/nevermoreclimanifest --save

Usage

When a place is deployed with nevermore deploy, the CLI finds this package's NevermoreCLIManifestUtils ModuleScript in the built place and writes the deployment metadata onto it as attributes. Because the data rides on the package's own instance it replicates to clients automatically, so any consumer can read it from either the client or the server:

local NevermoreCLIManifestUtils = require("NevermoreCLIManifestUtils")

local metadata = NevermoreCLIManifestUtils.getGameMetadata()
if metadata.deployed then
	print(string.format("%s @ %s (%s)", metadata.target, metadata.commit, metadata.timestamp))
else
	print("Undeployed build (Studio)")
end

getGameMetadata() returns a GameMetadata table:

| Field | Type | Description | | --- | --- | --- | | deployed | boolean | true only when injected by a nevermore deploy (false in Studio) | | commit | string? | Short git commit SHA | | version | string? | Full git commit SHA | | branch | string? | Git branch the build was made from | | target | string? | Deploy target name (e.g. "test", "integration") | | timestamp | string? | ISO 8601 UTC time of the deploy | | published | boolean? | true if published live (--publish), false if only Saved | | placeId | number? | Roblox place ID deployed to | | universeId | number? | Roblox universe ID deployed to | | basePlaceId | number? | Roblox place ID of the base place this build merged from | | basePlaceVersion | number? | Version of that base place the build was made from |

basePlaceVersion is the only record of which upstream Studio content a build contains: a "published" base place pin resolves at deploy time and the base place keeps moving afterwards, so it cannot be recovered later. Both base place fields are absent on a build that merged none.

Use NevermoreCLIManifestUtils.observeGameMetadata() for an Observable that fires the current snapshot and again whenever a field changes (for example when the metadata first replicates to a client), or isDeployed() for a quick boolean check.

If a place does not depend on this package, the CLI finds no injection point and the deploy proceeds unchanged.