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.

Release file contract index

Generated contract-file tables for supported and internal Buildish Release Tooling schemas.

This page groups the published JSON Schemas by file contract and contract posture.

Back to the reference overview.

File contract groups

Supported authored file contracts

Consumer-authored or component-authored file contracts that are part of the supported external release-tooling surface.

Contract file Root type(s) Schema file Audience Stability Summary
release-config.yaml ReleaseConfig component-config.schema.json supported stable Component-authored release-config.yaml contract for release policy and target integration settings.

Supported emitted file contracts

Stable emitted Buildish file contracts that workflows or humans may intentionally consume.

Contract file Root type(s) Schema file Audience Stability Summary
inspection-bundle.json InspectionBundleManifestV1 inspection-bundle-manifest-v1.schema.json supported stable Top-level manifest for a retained verify-rc inspection bundle.

Supported emitted non-file root contracts

Supported emitted JSON contract roots that do not correspond to one fixed checked-in path.

Root type(s) Schema file Audience Stability Summary
AttachGitHubCandidateManifestResult attach-github-candidate-manifest-result.schema.json supported stable Stable result of attaching one exact candidate manifest.
AttachGitHubReleaseManifestResult attach-github-release-manifest-result.schema.json supported stable Stable result of attaching one exact final release manifest.
CandidateManifestV1 candidate-manifest-v1.schema.json supported stable Stable Buildish manifest for one exact release candidate.
CreateGitHubCandidateTagResult create-github-candidate-tag-result.schema.json supported stable Stable result of creating one exact candidate tag.
FinalizeGitHubCandidateResult finalize-github-candidate-result.schema.json supported stable Stable finalization result for one exact GitHub release candidate.
InspectReproReportV1 inspect-repro-report-v1.schema.json supported stable Machine-readable inspect-repro --json output contract.
PublishGitHubFinalReleaseResult publish-github-final-release-result.schema.json supported stable Stable publication result for a direct GitHub final release.
ReadGitHubFinalReleaseResult read-github-final-release-result.schema.json supported stable Stable exact observation of a direct GitHub final release.
ReleaseManifestV1 release-manifest-v1.schema.json supported stable Stable Buildish manifest for one final direct or promoted release.
StageGitHubCandidateResult stage-github-candidate-result.schema.json supported stable Stable result of staging one exact GitHub release candidate.
StageGitHubFinalReleaseResult stage-github-final-release-result.schema.json supported stable Stable result of staging a direct GitHub final release.
VerifyGitHubCandidateResult verify-github-candidate-result.schema.json supported stable Stable verification result for one exact GitHub release candidate.
VerifyGitHubFinalReleaseResult verify-github-final-release-result.schema.json supported stable Stable verification result for a direct GitHub final release.
VerifyRcReportV1 verify-rc-report-v1.schema.json supported stable Machine-readable verify-rc report contract, typically written through --report-json.
VotePackageV1 vote-package-v1.schema.json supported stable Stable optional vote package bound to one candidate manifest digest.

Internal stable file contracts

Buildish-owned internal file contracts that are documented here for maintainability but are not part of the supported external API.

Contract file Root type(s) Schema file Audience Stability Summary
harness/scenarios/*.yaml HarnessScenario harness-scenario.schema.json internal stable Harness scenario contract for synthetic or act-backed release-workflow integration tests.
harness/release-harness.yaml ReleaseHarnessConfig release-harness-config.schema.json internal stable Committed harness configuration contract for local repository bindings and optional overrides.
artifact-manifest.json SecondaryArtifactManifestV1 secondary-artifact-manifest-v1.schema.json internal stable Typed secondary-artifact registration manifest fragment written by record-artifact.

Internal stable non-file root contracts

Buildish-owned internal root contracts and runtime payloads with stable current semantics but no external support promise.

Root type(s) Schema file Audience Stability Summary
AsfKeysTrustRootRead asf-keys-trust-root-read.schema.json internal stable Tolerant read model for ASF KEYS trust-root references carried through vote-materials loading.
AuthoritativeManifestReferenceRead authoritative-manifest-reference-read.schema.json internal stable Tolerant read model for the authoritative signed manifest reference used by vote-materials loading.
CandidateReleaseState candidate-release-state.schema.json internal stable Resolved provider-neutral state for one exact release candidate.
CommandContext command-context.schema.json internal stable Runtime command context built from validated release configuration.
DirectReleaseState direct-release-state.schema.json internal stable Resolved provider-neutral state for one direct release.
DraftGitHubReleaseRead draft-github-release-read.schema.json internal stable Tolerant read model for draft GitHub release coordinates recorded in vote materials.
FileLikeReproducibilityMetadata file-like-reproducibility-metadata.schema.json internal stable Inspection-bundle metadata payload for file-like reproducibility comparisons.
HarnessBuiltinGhRefMutationPayload harness-builtin-gh-ref-mutation-payload.schema.json internal stable Harness shim builtin payload describing a synthetic GitHub ref mutation request.
HarnessCommandTraceEntry harness-command-trace-entry.schema.json internal stable Structured command-trace record emitted by the harness shim for one intercepted invocation.
HarnessRunResultJson harness-run-result-json.schema.json internal stable Machine-readable JSON result for one harness scenario run.
HarnessSequenceRunResultJson harness-sequence-run-result-json.schema.json internal stable Machine-readable JSON result for a multi-scenario harness sequence run.
HarnessShimState harness-shim-state.schema.json internal stable Persisted subprocess-facing harness shim state used by intercepted tool wrappers.
MavenRepositoryInventoryV1 maven-repository-inventory-v1.schema.json internal stable Signed Maven repository inventory contract emitted for staged Maven repository verification.
MavenRepositoryPathResultReport maven-repository-path-result-report.schema.json internal stable Per-path Maven repository reproducibility comparison result retained in bundle metadata.
MavenRepositoryPathRuleReport maven-repository-path-rule-report.schema.json internal stable Rendered Maven repository per-path comparison rule retained in reproducibility metadata.
MavenRepositoryReproducibilityMetadata maven-repository-reproducibility-metadata.schema.json internal stable Inspection-bundle metadata payload for Maven repository reproducibility evidence.
OciImageReproducibilityMetadata oci-image-reproducibility-metadata.schema.json internal stable Inspection-bundle metadata payload for OCI image reproducibility evidence.
PromotionState promotion-state.schema.json internal stable Resolved provider-neutral state for exact candidate promotion.
RebuiltOutputSnapshot rebuilt-output-snapshot.schema.json internal stable Snapshot of one rebuilt output retained in reproducibility metadata.
ResolvedReleaseHarnessConfigJson resolved-release-harness-config-json.schema.json internal stable Machine-readable JSON payload for one resolved harness configuration.
RetainedArtifactSnapshot retained-artifact-snapshot.schema.json internal stable Snapshot of one retained staged or rebuilt artifact captured in reproducibility metadata.
SecondaryArtifactBase secondary-artifact-base.schema.json internal stable Common base shape shared across supported secondary-artifact manifest entries.
SourceArtifactReproducibilityMetadata source-artifact-reproducibility-metadata.schema.json internal stable Inspection-bundle metadata payload for source-artifact reproducibility evidence.
VerifyRcOverrideFileConfig verify-rc-override-file-config.schema.json internal stable Local non-canonical verify-rc reproducibility override file passed through --repro-override-file.

Internal unstable command action manifests

Internal workflow-coordination manifests written by commands. These are documented to aid maintenance and debugging, but they are intentionally unstable.

Root type(s) Schema file Audience Stability Summary
AttachGitHubReleaseAssetsManifest attach-github-release-assets-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by attach-github-release-assets.
BuildSourceRcManifest build-source-rc-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by build-source-rc.
CleanupDevSvnRcsManifest cleanup-dev-svn-rcs-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by cleanup-dev-svn-rcs.
CommandActionManifest command-action-manifest.schema.json internal unstable Common top-level shape for internal unstable command action manifests written through MANIFEST_PATH.
CreateFinalTagManifest create-final-tag-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by create-final-tag.
CreateRcMaterializationTagManifest create-rc-materialization-tag-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by create-rc-materialization-tag.
CreateReleaseBranchManifest create-release-branch-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by create-release-branch.
CreateSourceArtifactManifest create-source-artifact-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by create-source-artifact.
FinalizeDraftGitHubReleaseManifest finalize-draft-github-release-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by finalize-draft-github-release.
FinalizeRcVoteMaterialsManifest finalize-rc-vote-materials-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by finalize-rc-vote-materials.
MaterializeRcGitContentManifest materialize-rc-git-content-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by materialize-rc-git-content.
PrepareRcManifest prepare-rc-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by prepare-rc.
PruneOlderLineReleasesManifest prune-older-line-releases-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by prune-older-line-releases.
PublishAtrCandidateManifest publish-atr-candidate-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by publish-atr-candidate.
PublishDockerhubMovingTagsManifest publish-dockerhub-moving-tags-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by publish-dockerhub-moving-tags.
PublishSourceReleaseSvnManifest publish-source-release-svn-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by publish-source-release-svn.
RecordArtifactManifest record-artifact-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by record-artifact.
ReleaseVersionManifest release-version-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by release-version.
ReportAtrChecksManifest report-atr-checks-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by report-atr-checks.
SyncDraftGitHubReleaseManifest sync-draft-github-release-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by sync-draft-github-release.
UpdateMovingImageAliasesManifest update-moving-image-aliases-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by update-moving-image-aliases.
UpdateMovingTagsManifest update-moving-tags-manifest.schema.json internal unstable Internal unstable JSON action manifest emitted by update-moving-tags.