IMPORTANT: Developer documentation for the current development branch. This content is unreleased, may change without notice, and must not be treated as Buildish release documentation.

Harness configuration types

Committed and resolved release-harness configuration models.

Committed and resolved release-harness configuration models.

Back to the reference overview.

Type index

ReleaseHarnessConfig

Committed release-harness.yaml plus optional local overrides.

  • category: authored
  • ownership: consumer-owned
  • schema file: release-harness-config.schema.json
  • audience: internal
  • stability: stable
  • file contract: harness/release-harness.yaml
Field Type Required Description
schema_version Literal[‘1’] no Schema version of the enclosing Buildish JSON or YAML contract.
self_repository SelfRepositoryConfig yes Resolved binding for the primary workflow repository under harness control.
repository_overrides dict[str, RepositoryOverrideConfig] no Per-repository local override bindings resolved from the harness configuration.

RepositoryOverrideConfig

Committed harness settings for one explicit repository override.

  • category: authored
  • ownership: consumer-owned
  • file contract: (inner type)
Field Type Required Description
local_checkout_mode RepositoryOverrideCheckoutMode no Policy describing whether the related repository binding should resolve to a local checkout path.
local_path str no Resolved or configured local filesystem path associated with the related repository binding.

ResolvedReleaseHarnessConfigJson

Machine-readable JSON payload for one resolved harness config file.

Field Type Required Description
config_path str yes Filesystem path of the resolved configuration document.
local_override_path str yes Filesystem path of the optional local harness override file that was considered during config loading.
local_override_present bool yes Whether the optional local harness override file existed and was merged into the effective harness config.
self_repository ResolvedRepositoryBindingJson yes Resolved binding for the primary workflow repository under harness control.
repository_overrides dict[str, ResolvedRepositoryBindingJson] no Per-repository local override bindings resolved from the harness configuration.

ResolvedRepositoryBindingJson

Machine-readable JSON payload for one resolved harness repository binding.

  • category: runtime
  • ownership: runtime-derived
  • file contract: (inner type)
Field Type Required Description
repository_id str yes Logical repository identifier used by the harness configuration layer.
local_checkout_mode str yes Policy describing whether the related repository binding should resolve to a local checkout path.
local_path str yes Resolved or configured local filesystem path associated with the related repository binding.

SelfRepositoryConfig

Committed harness settings for the workflow repository under test.

  • category: authored
  • ownership: consumer-owned
  • file contract: (inner type)
Field Type Required Description
repository_id str yes Logical repository identifier used by the harness configuration layer.
local_checkout_mode SelfRepositoryCheckoutMode no Policy describing whether the related repository binding should resolve to a local checkout path.
local_path str no Resolved or configured local filesystem path associated with the related repository binding.