Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Build Trace Entry

Title: Build Trace Entry

Typecombining
RequiredNo
Additional propertiesEach additional property must conform to the schema

Description: A record of a successful build outcome for a specific derivation output.

This schema describes the JSON representation of a build trace entry.

Warning

This JSON format is currently experimental and subject to change.

Verision history:

  • Version 1: Original format

  • Version 2: Remove dependentRealisations

PropertyTypePatternTitle/Description
+ idobjectNo-
+ outPathobjectNo-
+ signaturesobjectNo-
- objectNo-
All of(Requirement)
Build Trace Key
Build Trace Value

1. Property Build Trace Key

Title: Build Trace Key

Typeobject
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/key

Description: A build trace entry is a key-value pair. This is the "key" part, refering to a derivation and output.

PropertyTypePatternTitle/Description
+ idstringNoDerivation Output ID

1.1. Property id

Title: Derivation Output ID

Typestring
RequiredYes

Description: Unique identifier for the derivation output that was built.

Format: {hash-quotient-drv}!{output-name}

Example: "sha256:ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad!foo"

Restrictions
Must match regular expression^sha256:[0-9a-f]{64}![a-zA-Z_][a-zA-Z0-9_-]*$ Test

2. Property Build Trace Value

Title: Build Trace Value

Typeobject
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/value

Description: A build trace entry is a key-value pair. This is the "value" part, describing an output.

PropertyTypePatternTitle/Description
+ outPathstringNoOutput Store Path
+ signaturesarray of stringNoBuild Signatures

2.1. Property outPath

Title: Output Store Path

Typestring
RequiredYes
Defined instore-path-v1.yaml

Description: The path to the store object that resulted from building this derivation for the given output name.

Restrictions
Min length34
Must match regular expression^[0123456789abcdfghijklmnpqrsvwxyz]{32}-.+$ Test

2.2. Property signatures

Title: Build Signatures

Typearray of string
RequiredYes

Description: A set of cryptographic signatures attesting to the authenticity of this build trace entry.

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
SignatureA single cryptographic signature

2.2.1. Signature

Title: Signature

Typestring
RequiredNo

Description: A single cryptographic signature

3. Property id

Typeobject
RequiredYes
Additional propertiesAny type allowed

4. Property outPath

Typeobject
RequiredYes
Additional propertiesAny type allowed

5. Property signatures

Typeobject
RequiredYes
Additional propertiesAny type allowed

6. Property additionalProperties

Typeobject
RequiredNo
Additional propertiesAny type allowed

Examples

Simple build trace entry

{
  "dependentRealisations": {},
  "id": "sha256:ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad!foo",
  "outPath": "g1w7hy3qg1w7hy3qg1w7hy3qg1w7hy3q-foo.drv",
  "signatures": []
}

Build trace entry with signature

{
  "dependentRealisations": {},
  "id": "sha256:ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad!foo",
  "outPath": "g1w7hy3qg1w7hy3qg1w7hy3qg1w7hy3q-foo.drv",
  "signatures": [
    "asdf:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=="
  ]
}