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.

Internal unstable command action manifest types

Machine-readable command action manifests written for workflow coordination. These are Buildish-owned internal input/output contracts and are intentionally unstable.

Machine-readable command action manifests written for workflow coordination. These are Buildish-owned internal input/output contracts and are intentionally unstable.

Back to the reference overview.

Type index

AttachGitHubReleaseAssetsManifest

Action manifest emitted after uploading primary and derived assets to a GitHub release.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘attach-github-release-assets’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
repository_slug NonEmptyString yes GitHub owner/name repository slug used for API calls and emitted release metadata.
release_id NonEmptyString yes GitHub release id associated with the related draft or final release record.
release_name str yes Human-facing GitHub release title used for the related draft or final release.
release_tag str yes GitHub release tag name as stored on the related release record.
release_url NonEmptyString yes Primary user-facing URL of the related GitHub release or published release artifact.
primary_asset_names list[NonEmptyString] yes Primary release asset names that Buildish attached or expected to attach to the selected GitHub release.
uploaded_asset_names list[NonEmptyString] yes GitHub release asset names that Buildish uploaded during the related command.
generated_checksum_asset_names list[NonEmptyString] yes Generated checksum asset names that Buildish attached or expected to attach to the GitHub release.
generated_signature_asset_names list[NonEmptyString] yes Generated detached-signature asset names that Buildish attached or expected to attach to the GitHub release.
checksum_algorithms list[NonEmptyString] yes Checksum algorithms that Buildish generated or expects for the related artifact set.
gpg_fingerprint str yes OpenPGP fingerprint of the signing key Buildish used or verified.

BuildSourceRcManifest

Action manifest emitted after building and staging the signed source RC bundle.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘build-source-rc’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
resolved_source_ref NonEmptyString yes Resolved source Git commit SHA that Buildish selected for release production or verification.
source_date_epoch NonEmptyString yes Canonical SOURCE_DATE_EPOCH integer carried through RC production and verification.
rc_tag NonEmptyString yes Exact RC Git tag, including the leading v prefix and -rcN suffix.
source_artifact_name NonEmptyString yes Filename of the staged source release artifact.
source_artifact_path NonEmptyString yes Filesystem path of the locally produced or staged source release artifact.
source_artifact_sha512 NonEmptyString yes SHA-512 digest of the staged or locally produced source release artifact.
source_artifact_sha512_path NonEmptyString yes Filesystem path of the .sha512 sidecar generated for the locally produced source artifact.
source_artifact_asc_path NonEmptyString yes Filesystem path of the detached OpenPGP signature file for the locally produced source artifact.
gpg_fingerprint NonEmptyString yes OpenPGP fingerprint of the signing key Buildish used.
staging_url NonEmptyString yes ASF dev/dist staging directory URL selected for the current RC.

CleanupDevSvnRcsManifest

Action manifest emitted after old or conflicting RC staging directories are removed.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘cleanup-dev-svn-rcs’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
dev_base_url NonEmptyString yes Configured ASF dist/dev base URL that the cleanup or publication action targeted.
deleted_rc_directories list[NonEmptyString] yes ASF dev/dist RC directories that Buildish deleted during cleanup.

CommandActionManifest

Common top-level shape for command action manifests.

Field Type Required Description
component NonEmptyString yes Component identifier for the Buildish command manifest or emitted action record.
action NonEmptyString yes Stable command action identifier written by one Buildish command manifest.

CreateFinalTagManifest

Action manifest emitted after creating or validating the final immutable release tag.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘create-final-tag’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
selected_rc_tag NonEmptyString no Optional RC tag selected for a candidate-based final release action; absent for direct releases.
final_tag NonEmptyString yes Final immutable Git tag that Buildish intends to publish for the released version.
target_commit NonEmptyString yes Git commit SHA that the related tag or alias operation targeted.
tag_creation_mode NonEmptyString yes Mode that Buildish used when creating or reusing the related annotated Git tag.
created_ref str yes Git ref name that Buildish created or reused while performing the related tag or ref action.

CreateRcMaterializationTagManifest

Action manifest emitted after tagging one detached RC materialization commit.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘create-rc-materialization-tag’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
resolved_source_ref NonEmptyString yes Resolved source Git commit SHA that Buildish selected for release production or verification.
rc_tag NonEmptyString yes Exact RC Git tag, including the leading v prefix and -rcN suffix.
target_commit NonEmptyString yes Git commit SHA that the related tag or alias operation targeted.
tag_target_origin Literal[‘materialized-commit’, ‘source-commit’] yes Origin that Buildish used for the target commit when tagging the RC materialization result.
cleanup_materialized_ref_name str yes Temporary materialization ref that Buildish considered for cleanup after tagging the RC.
cleanup_materialized_ref_mode NonEmptyString yes Policy that Buildish used when deciding whether to delete the temporary materialization ref after tagging.
tag_creation_mode NonEmptyString yes Mode that Buildish used when creating or reusing the related annotated Git tag.
created_ref str yes Git ref name that Buildish created or reused while performing the related tag or ref action.

CreateReleaseBranchManifest

Action manifest emitted after resolving or creating a release branch.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘create-release-branch’] no Stable command action identifier written by one Buildish command manifest.
release_line NonEmptyString yes Maintenance-line identifier used to group related versions, branches, and moving tags.
release_branch NonEmptyString yes Git branch name that Buildish resolved as the authoritative release branch.
source_ref NonEmptyString yes Source ref that Buildish used as the starting point for the related release-branch or materialization action.

CreateSourceArtifactManifest

Action manifest emitted after creating one local source release artifact.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘create-source-artifact’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
resolved_source_ref NonEmptyString yes Resolved source Git commit SHA that Buildish selected for release production or verification.
source_date_epoch NonEmptyString yes Canonical SOURCE_DATE_EPOCH integer carried through RC production and verification.
source_artifact_name NonEmptyString yes Filename of the staged source release artifact.
source_artifact_path NonEmptyString yes Filesystem path of the locally produced or staged source release artifact.
source_artifact_sha512 NonEmptyString yes SHA-512 digest of the staged or locally produced source release artifact.

FinalizeDraftGitHubReleaseManifest

Action manifest emitted after finalizing a selected GitHub draft release.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘finalize-draft-github-release’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
repository_slug NonEmptyString yes GitHub owner/name repository slug used for API calls and emitted release metadata.
release_id NonEmptyString yes GitHub release id associated with the related draft or final release record.
release_tag str yes GitHub release tag name as stored on the related release record.
release_name str yes Human-facing GitHub release title used for the related draft or final release.
release_url NonEmptyString yes Primary user-facing URL of the related GitHub release or published release artifact.
deleted_asset_names list[NonEmptyString] yes GitHub Release asset names that Buildish deleted during the related release-finalization step.
finalize_mode NonEmptyString yes Mode that Buildish used when finalizing the selected draft GitHub release.

FinalizeRcVoteMaterialsManifest

Action manifest emitted after publishing and signing final RC vote materials.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘finalize-rc-vote-materials’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
resolved_source_ref NonEmptyString yes Resolved source Git commit SHA that Buildish selected for release production or verification.
rc_tag NonEmptyString yes Exact RC Git tag, including the leading v prefix and -rcN suffix.
final_tag NonEmptyString yes Final immutable Git tag that Buildish intends to publish for the released version.
rc_tag_target_commit NonEmptyString yes Git commit SHA that the RC tag resolved to during verification or publication.
source_artifact_url NonEmptyString yes Canonical staged download URL of the source release artifact referenced by the RC vote materials.
authoritative_manifest_url NonEmptyString yes Canonical staged URL of the signed RC vote manifest.
authoritative_manifest_sha512 NonEmptyString yes SHA-512 digest of the authoritative staged RC vote manifest.
bootstrap_script_url NonEmptyString yes Staged URL of the emitted verify-rc bootstrap helper script.
bootstrap_script_sha512 NonEmptyString yes SHA-512 digest of the emitted verify-rc bootstrap script.
draft_release_url NonEmptyString yes GitHub draft release URL associated with the current RC or final release workflow.
secondary_artifact_count NonEmptyString yes Count of secondary artifacts associated with the related manifest or publication step.
mirrored_asset_names list[NonEmptyString] yes GitHub release asset names that Buildish mirrored from the staged vote materials into the draft release bundle.
gpg_fingerprint NonEmptyString yes OpenPGP fingerprint of the signing key Buildish used or verified.

MaterializeRcGitContentManifest

Action manifest emitted after building detached RC materialization Git content.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘materialize-rc-git-content’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
resolved_source_ref NonEmptyString yes Resolved source Git commit SHA that Buildish selected for release production or verification.
rc_tag NonEmptyString yes Exact RC Git tag, including the leading v prefix and -rcN suffix.
materialized_paths list[NonEmptyString] yes Filesystem paths that the materialization step created or refreshed for the current RC.
materialized_commit_sha NonEmptyString yes Git commit SHA of the materialized tree that Buildish created for the RC tagging workflow.
materialized_ref_name NonEmptyString yes Temporary Git ref name that Buildish created or reused for RC materialization.
materialized_ref_mode NonEmptyString yes Policy that Buildish used when creating or reusing the temporary materialization ref.

PrepareRcManifest

Action manifest emitted after prepare-rc resolves one RC workflow state bundle.

  • category: emitted
  • ownership: tooling-derived
  • schema file: prepare-rc-manifest.schema.json
  • audience: internal
  • stability: unstable
  • file contract: (inner type)
Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘prepare-rc’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
resolved_source_ref NonEmptyString yes Resolved source Git commit SHA that Buildish selected for release production or verification.
source_date_epoch NonEmptyString yes Canonical SOURCE_DATE_EPOCH integer carried through RC production and verification.
resolved_release_branch NonEmptyString yes Release branch name that Buildish resolved for the selected version.
rc_number NonEmptyString yes Numeric RC sequence selected for the related version.
rc_tag NonEmptyString yes Exact RC Git tag, including the leading v prefix and -rcN suffix.
final_tag NonEmptyString yes Final immutable Git tag that Buildish intends to publish for the released version.
source_artifact_name NonEmptyString yes Filename of the staged source release artifact.
source_artifact_root_name NonEmptyString yes Root directory name that the source release archive should unpack to.
source_artifact_prefix_path NonEmptyString yes Top-level path prefix inside the source release archive.
staging_url NonEmptyString yes ASF dev/dist staging directory URL selected for the current RC.
cleanup_existing_rc_staging Literal[’true’] no Whether the prepare-rc flow cleaned up pre-existing same-version RC staging state before publishing new materials.
draft_release_action Literal[‘recreate’] no Draft GitHub release convergence action that prepare-rc used when emitting new vote materials.
final_tag_mode NonEmptyString yes Configured or recorded policy describing how the final immutable release tag should be created for this component or release run.

PruneOlderLineReleasesManifest

Action manifest emitted after pruning older same-line releases from dist/release.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘prune-older-line-releases’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
release_line NonEmptyString yes Maintenance-line identifier used to group related versions, branches, and moving tags.
pruned_versions list[NonEmptyString] yes Older release versions that Buildish removed from the active release line while pruning prior dist/release artifacts.
release_base_url NonEmptyString yes Base ASF dist/release URL associated with the related publication action.

PublishAtrCandidateManifest

Action manifest emitted after publishing one release candidate to ATR.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘publish-atr-candidate’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
rc_tag NonEmptyString yes Exact RC Git tag, including the leading v prefix and -rcN suffix.
atr_base_url NonEmptyString yes Base ATR service URL that Buildish used for the related candidate upload or status query.
atr_committee NonEmptyString yes ASF committee slug that Buildish reported to ATR for the related release candidate.
atr_project NonEmptyString yes ATR project or product-line identifier that Buildish reported for the related release candidate.
atr_release_mode NonEmptyString yes ATR release mode that Buildish selected for the related publication run.
atr_phase NonEmptyString yes ATR publication phase that Buildish targeted or reported for the related candidate.
atr_latest_revision str yes Most recent ATR candidate revision known to Buildish when it emitted the related manifest or report.
uploaded_file_names list[NonEmptyString] yes File names that Buildish uploaded to ATR for the related candidate.
waited_for_checks Literal[’true’, ‘false’] yes Whether Buildish waited for ATR checks to complete before emitting the related command manifest.
atr_total_checks NonEmptyString yes Total number of ATR checks observed for the related candidate revision.
atr_failure_count NonEmptyString yes Number of ATR checks that reported a failing outcome for the related candidate or report.
atr_exception_count NonEmptyString yes Number of ATR checks that ended in an exception state for the related candidate or report.
atr_warning_count NonEmptyString yes Number of ATR checks that reported warnings for the related candidate or report.

PublishDockerhubMovingTagsManifest

Action manifest emitted after publishing moving Docker Hub image aliases.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘publish-dockerhub-moving-tags’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
source_image NonEmptyString yes Exact source OCI image reference that should be copied to produce the published moving aliases.
image_repository NonEmptyString yes Container image repository name without the moving tag or digest suffix.
published_alias_refs list[NonEmptyString] yes Fully qualified target image references that Buildish published as moving aliases.

PublishSourceReleaseSvnManifest

Action manifest emitted after promoting a verified source artifact into dist/release.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘publish-source-release-svn’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
selected_rc_tag NonEmptyString yes RC tag that Buildish selected as the winning release candidate for a final release action.
source_url NonEmptyString yes Source URL that Buildish copied or verified during a publication action.
target_url NonEmptyString yes Destination URL that Buildish published or copied content to.
verified_source_artifact_sha512 NonEmptyString yes Verified SHA-512 digest of the source release artifact promoted to ASF dist/release.
publish_mode NonEmptyString yes Mode that Buildish used when publishing the verified source artifact to ASF dist/release.

RecordArtifactManifest

Action manifest emitted after writing one typed secondary-artifact bundle.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘record-artifact’] no Stable command action identifier written by one Buildish command manifest.
artifact_id NonEmptyString yes Stable identifier for one source, secondary, or emitted artifact within Buildish release tooling.
kind NonEmptyString yes Declared artifact or report kind discriminator.
artifact_manifest_path NonEmptyString yes Filesystem path to the emitted secondary-artifact manifest fragment.
artifact_bundle_dir NonEmptyString yes Directory that contains one emitted secondary-artifact registration bundle.
inventory_paths list[NonEmptyString] yes Filesystem paths of supplemental inventory files emitted alongside one artifact bundle.

ReleaseVersionManifest

Action manifest emitted after a full release-version orchestration run completes.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘release-version’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
release_line NonEmptyString yes Maintenance-line identifier used to group related versions, branches, and moving tags.
selected_rc_tag NonEmptyString yes RC tag that Buildish selected as the winning release candidate for a final release action.
final_tag NonEmptyString yes Final immutable Git tag that Buildish intends to publish for the released version.
archive_versions list[NonEmptyString] yes Older same-line release versions that Buildish resolved for archival pruning.
release_url NonEmptyString yes Primary user-facing URL of the related GitHub release or published release artifact.
moving_tags list[NonEmptyString] yes Derived moving tags or aliases that should point at the final released version.
final_tag_mode NonEmptyString yes Configured or recorded policy describing how the final immutable release tag should be created for this component or release run.

ReportAtrChecksManifest

Action manifest emitted after summarizing ATR checks for one candidate revision.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘report-atr-checks’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
rc_tag NonEmptyString yes Exact RC Git tag, including the leading v prefix and -rcN suffix.
atr_base_url NonEmptyString yes Base ATR service URL that Buildish used for the related candidate upload or status query.
atr_committee NonEmptyString yes ASF committee slug that Buildish reported to ATR for the related release candidate.
atr_project NonEmptyString yes ATR project or product-line identifier that Buildish reported for the related release candidate.
atr_phase NonEmptyString yes ATR publication phase that Buildish targeted or reported for the related candidate.
atr_latest_revision str yes Most recent ATR candidate revision known to Buildish when it emitted the related manifest or report.
atr_reported_revision str yes ATR candidate revision that Buildish specifically reported in the related checks summary.
atr_total_checks NonEmptyString yes Total number of ATR checks observed for the related candidate revision.
atr_failure_count NonEmptyString yes Number of ATR checks that reported a failing outcome for the related candidate or report.
atr_exception_count NonEmptyString yes Number of ATR checks that ended in an exception state for the related candidate or report.
atr_warning_count NonEmptyString yes Number of ATR checks that reported warnings for the related candidate or report.
atr_success_count NonEmptyString yes Number of ATR checks that reported success for the related candidate or report.
strict_checking Literal[’true’, ‘false’] yes Whether the related check or reporting step should fail the command when warnings or failures are present.
would_block_release Literal[’true’, ‘false’] yes Whether the related check result would block release publication under the requested strictness policy.

SyncDraftGitHubReleaseManifest

Action manifest emitted after synchronizing the draft GitHub release with staged RC artifacts.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘sync-draft-github-release’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
repository_slug NonEmptyString yes GitHub owner/name repository slug used for API calls and emitted release metadata.
resolved_source_ref NonEmptyString yes Resolved source Git commit SHA that Buildish selected for release production or verification.
rc_tag NonEmptyString yes Exact RC Git tag, including the leading v prefix and -rcN suffix.
final_tag NonEmptyString yes Final immutable Git tag that Buildish intends to publish for the released version.
staging_url NonEmptyString yes ASF dev/dist staging directory URL selected for the current RC.
deleted_release_ids list[NonEmptyString] yes GitHub draft release ids that Buildish deleted while converging on one selected release candidate.
release_id str yes GitHub release id associated with the related draft or final release record.
release_tag str yes GitHub release tag name as stored on the related release record.
release_name str yes Human-facing GitHub release title used for the related draft or final release.
release_url NonEmptyString yes Primary user-facing URL of the related GitHub release or published release artifact.
sync_mode NonEmptyString yes Mode that Buildish used when reconciling the selected draft GitHub release with staged RC materials.

UpdateMovingImageAliasesManifest

Action manifest emitted after resolving moving OCI image aliases for publication.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘update-moving-image-aliases’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
exact_image_tag NonEmptyString yes Exact released image tag that Buildish uses as the source for moving image aliases.
image_aliases list[NonEmptyString] yes Derived moving container tags that should point at the exact released image tag.

UpdateMovingTagsManifest

Action manifest emitted after updating moving Git tags for a final release.

Field Type Required Description
component object yes Component identifier for the Buildish command manifest or emitted action record.
action Literal[‘update-moving-tags’] no Stable command action identifier written by one Buildish command manifest.
version NonEmptyString yes Release version string without a leading v prefix.
final_tag NonEmptyString yes Final immutable Git tag that Buildish intends to publish for the released version.
target_commit NonEmptyString yes Git commit SHA that the related tag or alias operation targeted.
updated_tags list[NonEmptyString] yes Moving tags that Buildish updated during the related tag-publication action.
skipped_tags list[NonEmptyString] yes Moving tags that Buildish intentionally left unchanged during the related update operation.
tag_update_modes list[NonEmptyString] yes Per-tag update outcomes describing how each moving tag was handled during the related publication run.