Skip to content

Commit 78beb48

Browse files
committed
docs: prepare Bering v0.3.4 release
1 parent 179e94c commit 78beb48

8 files changed

Lines changed: 43 additions & 31 deletions

File tree

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
## Unreleased
44

5+
## v0.3.4
6+
7+
Patch release for the post-`v0.3.3` capability backlog.
8+
9+
### Added
10+
11+
- Signal-quality sidecar reports for batch model artifacts, batch snapshot artifacts, runtime snapshots, and runtime projection snapshots.
12+
- Enrichment onboarding docs and examples for moving from trace-only discovery to overlay and `topology_api` inputs.
13+
- Operator-facing runtime reconciliation summary output, including a Markdown file and `GET /reconciliation/summary`.
14+
- Reference non-trace service-catalog adapter example that maps external inventory-style input back into the existing `topology_api` contract.
15+
- Checked-in adapter-generated `topology_api`, model, snapshot, and signal-quality example artifacts.
16+
517
## v0.3.3
618

719
Patch release focused on release metadata hygiene after the `v0.3.2` hardening release.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
[![ci](https://img.shields.io/github/actions/workflow/status/MB3R-Lab/Bering/ci.yml?branch=main&label=ci)](https://github.com/MB3R-Lab/Bering/actions/workflows/ci.yml)
66
[![publish-schema](https://img.shields.io/github/actions/workflow/status/MB3R-Lab/Bering/publish-schema.yml?branch=main&label=publish-schema)](https://github.com/MB3R-Lab/Bering/actions/workflows/publish-schema.yml)
77
[![Go version](https://img.shields.io/github/go-mod/go-version/MB3R-Lab/Bering)](https://github.com/MB3R-Lab/Bering/blob/main/go.mod)
8-
[![Current release](https://img.shields.io/badge/current-v0.3.3-blue)](https://github.com/MB3R-Lab/Bering/releases/tag/v0.3.3)
8+
[![Current release](https://img.shields.io/badge/current-v0.3.4-blue)](https://github.com/MB3R-Lab/Bering/releases/tag/v0.3.4)
99
[![Public schema](https://img.shields.io/badge/public_schema-1.0%20%7C%201.1-blue)](https://github.com/MB3R-Lab/Bering/blob/main/VERSIONING.md)
1010

11-
`Bering v0.3.3` is the current product release of Bering: a discovery and publishing layer for service topology and endpoint contracts.
11+
`Bering v0.3.4` is the current product release of Bering: a discovery and publishing layer for service topology and endpoint contracts.
1212

1313
Bering turns trace input or explicit topology input into stable JSON artifacts, and it can also run as a long-lived runtime service that emits rolling discovery snapshots plus conservative reconciliation views for trace gaps.
1414

@@ -28,8 +28,8 @@ Bering owns discovery and discovery-side public contracts. It does not own simul
2828

2929
Do not treat the product release tag as the schema contract version.
3030

31-
- Current product release for this repository: `Bering v0.3.3`
32-
- Current product git tag / GitHub Release: `v0.3.3`
31+
- Current product release for this repository: `Bering v0.3.4`
32+
- Current product git tag / GitHub Release: `v0.3.4`
3333
- Default emitted schema contracts now are:
3434
- `io.mb3r.bering.model@1.1.0`
3535
- `io.mb3r.bering.snapshot@1.1.0`
@@ -60,7 +60,7 @@ Also packaged today:
6060
Example:
6161

6262
```bash
63-
tar -xzf bering_0.3.3_linux_amd64.tar.gz
63+
tar -xzf bering_0.3.4_linux_amd64.tar.gz
6464
./bering help
6565
```
6666

RELEASING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Product releases and schema publishing are separate operations:
99
- product release tags: `vX.Y.Z`
1010
- schema publishing tags: `schema-vA.B.C`
1111

12-
Product releases advance independently from the public schema contracts. As of the current release line, use `v0.3.3` for the product release while the default emitted public schema contracts are `1.1.0` and the preserved `1.0.0` contracts remain available for validation and pinned consumers.
12+
Product releases advance independently from the public schema contracts. As of the current release line, use `v0.3.4` for the product release while the default emitted public schema contracts are `1.1.0` and the preserved `1.0.0` contracts remain available for validation and pinned consumers.
1313

1414
## Prerequisites
1515

@@ -28,7 +28,7 @@ Dry-run without publishing:
2828

2929
```bash
3030
make release-dry-run \
31-
VERSION=0.3.3 \
31+
VERSION=0.3.4 \
3232
GIT_SHA="$(git rev-parse HEAD)" \
3333
BUILD_DATE="$(git show -s --format=%cI HEAD)"
3434
```
@@ -37,7 +37,7 @@ Full local release payload with OCI publish:
3737

3838
```bash
3939
make release-local \
40-
VERSION=0.3.3 \
40+
VERSION=0.3.4 \
4141
GIT_SHA="$(git rev-parse HEAD)" \
4242
BUILD_DATE="$(git show -s --format=%cI HEAD)" \
4343
IMAGE_REPOSITORY=ghcr.io/mb3r-lab/bering \
@@ -49,8 +49,8 @@ If the chart version must intentionally differ from the app version:
4949

5050
```bash
5151
make chart-package \
52-
VERSION=0.3.3 \
53-
CHART_VERSION=0.3.3-chart.1 \
52+
VERSION=0.3.4 \
53+
CHART_VERSION=0.3.4-chart.1 \
5454
ALLOW_CHART_VERSION_MISMATCH=1
5555
```
5656

@@ -80,7 +80,7 @@ These variables control the release payload:
8080
- `CHART_VERSION`: optional explicit chart version
8181
- `ALLOW_CHART_VERSION_MISMATCH=1`: required when `CHART_VERSION != VERSION`
8282

83-
For `v0.3.3`, `VERSION=0.3.3` while the default emitted public schema contracts are `1.1.0`.
83+
For `v0.3.4`, `VERSION=0.3.4` while the default emitted public schema contracts are `1.1.0`.
8484

8585
## Expected Output
8686

VERSIONING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ App version changes govern the Bering CLI, the runtime service behavior, the ins
2626

2727
Examples:
2828

29-
- product release tag `v0.3.3` identifies the Bering `0.3.3` release payload
30-
- generated `release-manifest.json` records `"app_version": "0.3.3"` for that payload
29+
- product release tag `v0.3.4` identifies the Bering `0.3.4` release payload
30+
- generated `release-manifest.json` records `"app_version": "0.3.4"` for that payload
3131

3232
## Schema Contract Versions
3333

docs/install.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Install
22

3-
Bering `v0.3.3` is the current product release. It emits `io.mb3r.bering.model@1.1.0` and `io.mb3r.bering.snapshot@1.1.0` by default, while still validating the preserved `1.0.0` contracts.
3+
Bering `v0.3.4` is the current product release. It emits `io.mb3r.bering.model@1.1.0` and `io.mb3r.bering.snapshot@1.1.0` by default, while still validating the preserved `1.0.0` contracts.
44

55
## Binary Archives
66

@@ -14,18 +14,18 @@ Supported release targets:
1414
- `darwin/arm64`
1515
- `windows/amd64`
1616

17-
Example release asset names for `v0.3.3`:
17+
Example release asset names for `v0.3.4`:
1818

19-
- `bering_0.3.3_linux_amd64.tar.gz`
20-
- `bering_0.3.3_linux_arm64.tar.gz`
21-
- `bering_0.3.3_darwin_amd64.tar.gz`
22-
- `bering_0.3.3_darwin_arm64.tar.gz`
23-
- `bering_0.3.3_windows_amd64.zip`
19+
- `bering_0.3.4_linux_amd64.tar.gz`
20+
- `bering_0.3.4_linux_arm64.tar.gz`
21+
- `bering_0.3.4_darwin_amd64.tar.gz`
22+
- `bering_0.3.4_darwin_arm64.tar.gz`
23+
- `bering_0.3.4_windows_amd64.zip`
2424

2525
Example:
2626

2727
```bash
28-
tar -xzf bering_0.3.3_linux_amd64.tar.gz
28+
tar -xzf bering_0.3.4_linux_amd64.tar.gz
2929
./bering help
3030
```
3131

@@ -40,8 +40,8 @@ go build ./cmd/bering
4040
Pull the published runtime image:
4141

4242
```bash
43-
docker pull ghcr.io/mb3r-lab/bering:v0.3.3
44-
docker run --rm ghcr.io/mb3r-lab/bering:v0.3.3 help
43+
docker pull ghcr.io/mb3r-lab/bering:v0.3.4
44+
docker run --rm ghcr.io/mb3r-lab/bering:v0.3.4 help
4545
```
4646

4747
The release manifest records all published image references and the final digest in `oci_images`.
@@ -51,13 +51,13 @@ The release manifest records all published image references and the final digest
5151
Install directly from the published OCI chart:
5252

5353
```bash
54-
helm install bering oci://ghcr.io/mb3r-lab/charts/bering --version 0.3.3
54+
helm install bering oci://ghcr.io/mb3r-lab/charts/bering --version 0.3.4
5555
```
5656

5757
Override the image repository, tag, or digest if you mirror artifacts:
5858

5959
```bash
60-
helm install bering oci://ghcr.io/mb3r-lab/charts/bering --version 0.3.3 \
60+
helm install bering oci://ghcr.io/mb3r-lab/charts/bering --version 0.3.4 \
6161
--set image.repository=ghcr.io/mb3r-lab/bering \
6262
--set image.digest=sha256:...
6363
```
@@ -67,7 +67,7 @@ helm install bering oci://ghcr.io/mb3r-lab/charts/bering --version 0.3.3 \
6767
Download `bering-contracts_<version>.tar.gz` to consume the public schema contracts offline:
6868

6969
```bash
70-
tar -xzf bering-contracts_0.3.3.tar.gz
70+
tar -xzf bering-contracts_0.3.4.tar.gz
7171
cat contracts-manifest.json
7272
```
7373

docs/planning/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ This directory keeps checked-in planning notes for active and recently completed
44

55
GitHub Issues and Milestones are the authoritative task tracker for committed implementation work. These checked-in notes are supplemental design and implementation context only; they should not duplicate open or closed task lists from the tracker.
66

7-
For the active product capability backlog, use the pinned [delivery tracker](https://github.com/MB3R-Lab/Bering/issues/19) and the active [GitHub milestone](https://github.com/MB3R-Lab/Bering/milestone/4).
7+
For current delivery status, use the pinned [delivery tracker](https://github.com/MB3R-Lab/Bering/issues/19).
88

99
## Milestones
1010

11-
Active GitHub tracker milestone:
11+
Recently completed GitHub tracker milestone:
1212

1313
- [Post-v0.3.3 product capability backlog](https://github.com/MB3R-Lab/Bering/milestone/4)
1414

docs/planning/minor-schema-contract-evolution/implementation-note.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
## Release And Publication Boundary
2929

3030
- Product release versioning remains separate from schema contract versioning.
31-
- The current product line is `v0.3.3`, and it emits `1.1.0` contracts by default.
31+
- The current product line is `v0.3.4`, and it emits `1.1.0` contracts by default.
3232
- The schema publication tag used for external publication is `schema-v1.1.0`.
33-
- The `1.1.0` schema line is now published on GitHub Pages, was introduced in the `v0.3.1` product release, and remains the default emitted line in `v0.3.3`.
33+
- The `1.1.0` schema line is now published on GitHub Pages, was introduced in the `v0.3.1` product release, and remains the default emitted line in `v0.3.4`.
3434

3535
## Explicit Non-Goals For This Minor
3636

docs/schema-publishing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This workflow is separate from the product release workflow:
1111

1212
For the current release line, that means:
1313

14-
- product release: `v0.3.3`
14+
- product release: `v0.3.4`
1515
- schema publishing: `schema-v1.1.0`
1616

1717
## One-time repository setup

0 commit comments

Comments
 (0)