Skip to content

Commit b05019e

Browse files
committed
docs: treat release manifest as generated asset
1 parent 2df1738 commit b05019e

7 files changed

Lines changed: 9 additions & 148 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Binaries
22
bin/
33
dist/
4+
release-manifest.json
45
*.exe
56
*.dll
67
*.so

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![ci-template-smoke](https://img.shields.io/github/actions/workflow/status/MB3R-Lab/Sheaft/ci-template-smoke.yml?branch=main&label=ci-template-smoke)](https://github.com/MB3R-Lab/Sheaft/actions/workflows/ci-template-smoke.yml)
66
[![schema-contract](https://img.shields.io/github/actions/workflow/status/MB3R-Lab/Sheaft/schema-contract.yml?branch=main&label=schema-contract)](https://github.com/MB3R-Lab/Sheaft/actions/workflows/schema-contract.yml)
77
[![Go version](https://img.shields.io/github/go-mod/go-version/MB3R-Lab/Sheaft)](https://github.com/MB3R-Lab/Sheaft/blob/main/go.mod)
8-
[![Status](https://img.shields.io/badge/status-technical_preview-orange)](https://github.com/MB3R-Lab/Sheaft/releases/tag/v0.2.2)
8+
[![Technical preview](https://img.shields.io/badge/preview-v0.2.2-orange)](https://github.com/MB3R-Lab/Sheaft/releases/tag/v0.2.2)
99
[![Bering support](https://img.shields.io/badge/Bering-1.0%20%7C%201.1-blue)](https://github.com/MB3R-Lab/Sheaft/blob/main/docs/compatibility-matrix.md)
1010

1111
Sheaft is a downstream resilience posture engine and CI/CD gate for model artifacts produced by Bering or another compatible upstream producer.

RELEASING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ The canonical release contract is the generated payload:
1010

1111
GitHub Releases publish that payload, but GitHub metadata is not the source of truth.
1212

13+
`compatibility-manifest.json` is intentionally checked in because it mirrors the current strict upstream contract pins and is drift-checked in CI. `release-manifest.json` is release-specific and must not be committed from `main`; it is generated during `make release-dry-run`, `make release-local`, and tag-driven release publishing, then uploaded as a release asset.
14+
1315
## Ownership Boundary
1416

1517
- Bering owns upstream artifact schemas and release metadata.

VERSIONING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Sheaft has multiple version surfaces. They are related, but they are not interch
66

77
- Format: `X.Y.Z`
88
- Source of truth for tagged releases: Git tag `vX.Y.Z`
9-
- Stored in `release-manifest.json` as `app_version`
9+
- Stored in the generated release asset `release-manifest.json` as `app_version`
1010
- Controls binary archive names, chart packaging version override, and image release tags
1111

1212
## 2. Upstream Contract Compatibility
@@ -31,7 +31,7 @@ This is compatibility metadata, not ownership metadata.
3131
- Format: `X.Y.Z`
3232
- Published as an OCI chart, not through a classic Helm repository
3333
- Defaults to the app version for a tagged release
34-
- Recorded in `release-manifest.json` under `chart.version`
34+
- Recorded in the generated release asset `release-manifest.json` under `chart.version`
3535

3636
## 4. Sheaft-Owned Config and Overlay Schemas
3737

docs/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The current public technical preview is `v0.2.2`. Prefer release assets for evaluation and automation; use `go install` or `go build` as fallback paths.
44

5-
The machine-readable entrypoint for release consumers is `release-manifest.json`. It records exact archive names, checksums, image references, chart version, and the default config pack asset for a given release.
5+
The machine-readable entrypoint for release consumers is the `release-manifest.json` asset attached to each GitHub Release. It records exact archive names, checksums, image references, chart version, and the default config pack asset for that release.
66

77
## Preferred: Release Binary + Default Config Pack
88

docs/release-assets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ The canonical files are:
66

77
- `dist/`
88
- `compatibility-manifest.json`
9-
- `release-manifest.json`
9+
- `release-manifest.json` as a generated release asset, not a committed `main`-branch file
1010

1111
## Asset Inventory
1212

13-
`release-manifest.json` describes:
13+
The release asset `release-manifest.json` describes:
1414

1515
- product name
1616
- app version

release-manifest.json

Lines changed: 0 additions & 142 deletions
This file was deleted.

0 commit comments

Comments
 (0)