Skip to content

RELEASING.md

Latest commit

 

History

History
58 lines (41 loc) · 1.59 KB

RELEASING.md

File metadata and controls

58 lines (41 loc) · 1.59 KB

RELEASING

This repository releases integration artifacts, not application binaries.

The canonical source of truth is the local dist/ payload plus dist/release-manifest.json. GitHub Releases and OCI chart publication are publishing surfaces around that payload.

Release Outputs

Each stack release is expected to publish:

  • mb3r-stack-<version>.tgz
  • mb3r-assets-<version>.tgz
  • stack-manifest.json
  • compatibility-matrix.json
  • release-manifest.json
  • release-manifest.schema.json
  • release-notes.md
  • SHA256SUMS.txt
  • sbom.cdx.json

Pre-Release Checklist

  1. Update compat/stack-manifest.json.
  2. Update compat/compatibility-matrix.json.
  3. Confirm upstream release manifests, chart references, and image digests match the chosen Bering and Sheaft releases.
  4. Confirm dashboard and collector asset versions match the manifest.
  5. Run:
python -m pip install -r requirements.txt
make validate
make release-dry-run
  1. Review the generated files in dist/.

Publishing

The canonical packaging logic lives in scripts/.

GitHub release automation consumes those scripts to:

  • package the Helm chart
  • package the asset archive
  • generate checksums
  • generate a CycloneDX SBOM
  • publish the chart to an OCI registry
  • attach release assets to the tagged release

OCI Chart Publication

The chart is intended to be pushed with Helm to an OCI registry:

helm push dist/charts/mb3r-stack-<version>.tgz oci://<registry>/<namespace>/charts

Local dry runs do not require Helm, but CI installs Helm and performs helm lint plus OCI publication on release tags.