Skip to content

Commit b1e427e

Browse files
committed
Refresh documentation for v0.2.0
1 parent 6e71ea2 commit b1e427e

5 files changed

Lines changed: 38 additions & 38 deletions

File tree

README.md

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

3-
`Bering v0.1.0` is the first public product release of Bering: a discovery and publishing layer for service topology and endpoint contracts.
3+
`Bering v0.2.0` is the current product release of Bering: a discovery and publishing layer for service topology and endpoint contracts.
44

55
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.
66

@@ -20,14 +20,14 @@ Bering owns discovery and discovery-side public contracts. It does not own simul
2020

2121
Do not treat the product release tag as the schema contract version.
2222

23-
- Product release for this repository: `Bering v0.1.0`
24-
- Product git tag / GitHub Release: `v0.1.0`
23+
- Current product release for this repository: `Bering v0.2.0`
24+
- Current product git tag / GitHub Release: `v0.2.0`
2525
- Public schema contracts emitted by this release remain:
2626
- `io.mb3r.bering.model@1.0.0`
2727
- `io.mb3r.bering.snapshot@1.0.0`
2828
- Schema publishing tag remains separate: `schema-v1.0.0`
2929

30-
In other words: Bering `v0.1.0` ships a first public product release while continuing to emit the already-stable schema contracts at `1.0.0`.
30+
In other words: Bering `v0.2.0` advances the product release line while continuing to emit the already-stable schema contracts at `1.0.0`.
3131

3232
## Installation
3333

@@ -49,7 +49,7 @@ Also packaged today:
4949
Example:
5050

5151
```bash
52-
tar -xzf bering_0.1.0_linux_amd64.tar.gz
52+
tar -xzf bering_0.2.0_linux_amd64.tar.gz
5353
./bering help
5454
```
5555

RELEASING.md

Lines changed: 8 additions & 8 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-
For the first public product release, use `v0.1.0` for the product release and keep the public schema contracts pinned at `1.0.0`.
12+
Product releases advance independently from the public schema contracts. As of the current release line, use `v0.2.0` for the product release while the public schema contracts remain pinned at `1.0.0`.
1313

1414
## Prerequisites
1515

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

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

3838
```bash
3939
make release-local \
40-
VERSION=0.1.0 \
40+
VERSION=0.2.0 \
4141
GIT_SHA="$(git rev-parse HEAD)" \
4242
BUILD_DATE="$(git show -s --format=%cI HEAD)" \
43-
IMAGE_REPOSITORY=registry.example.com/bering \
44-
CHART_OCI_REPOSITORY=oci://registry.example.com/charts \
43+
IMAGE_REPOSITORY=ghcr.io/mb3r-lab/bering \
44+
CHART_OCI_REPOSITORY=oci://ghcr.io/mb3r-lab/charts \
4545
PUBLISH_OCI=1
4646
```
4747

4848
If the chart version must intentionally differ from the app version:
4949

5050
```bash
5151
make chart-package \
52-
VERSION=0.1.0 \
53-
CHART_VERSION=0.1.1 \
52+
VERSION=0.2.0 \
53+
CHART_VERSION=0.2.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.1.0`, `VERSION=0.1.0` while the emitted public schema contracts remain `1.0.0`.
83+
For `v0.2.0`, `VERSION=0.2.0` while the emitted public schema contracts remain `1.0.0`.
8484

8585
## Expected Output
8686

VERSIONING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
Bering separates product release versioning from public schema contract versioning.
44

5-
For the first public product release:
5+
For the current published product release:
66

7-
- product release tag: `v0.1.0`
8-
- product version in release automation: `0.1.0`
7+
- product release tag: `v0.2.0`
8+
- product version in release automation: `0.2.0`
99
- schema publishing tag: `schema-v1.0.0`
1010
- emitted schema contracts:
1111
- `io.mb3r.bering.model@1.0.0`
@@ -23,8 +23,8 @@ App version changes govern the Bering CLI, the runtime service behavior, the ins
2323

2424
Examples:
2525

26-
- product release `v0.1.0` identifies the first public Bering release
27-
- `dist/release-manifest.json` records `"app_version": "0.1.0"`
26+
- product release `v0.2.0` identifies the current Bering release line
27+
- `dist/release-manifest.json` records `"app_version": "0.2.0"`
2828

2929
## Schema Contract Versions
3030

@@ -42,8 +42,8 @@ Each schema contract has its own version, URI, and digest. Those values are inde
4242

4343
Examples:
4444

45-
- Bering `v0.1.0` still emits `io.mb3r.bering.model@1.0.0`
46-
- Bering `v0.1.0` still emits `io.mb3r.bering.snapshot@1.0.0`
45+
- Bering `v0.2.0` still emits `io.mb3r.bering.model@1.0.0`
46+
- Bering `v0.2.0` still emits `io.mb3r.bering.snapshot@1.0.0`
4747
- `schema-v1.0.0` publishes the schema files to GitHub Pages; it is not a product release tag
4848

4949
Rules:

docs/install.md

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

3-
Bering `v0.1.0` is the first public product release. It still emits the stable public schema contracts `io.mb3r.bering.model@1.0.0` and `io.mb3r.bering.snapshot@1.0.0`.
3+
Bering `v0.2.0` is the current product release. It still emits the stable public schema contracts `io.mb3r.bering.model@1.0.0` and `io.mb3r.bering.snapshot@1.0.0`.
44

55
## Binary Archives
66

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

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

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

2525
Example:
2626

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

@@ -37,28 +37,28 @@ go build ./cmd/bering
3737

3838
## OCI Image
3939

40-
Pull the runtime image from any OCI registry:
40+
Pull the published runtime image:
4141

4242
```bash
43-
docker pull registry.example.com/bering:v0.1.0
44-
docker run --rm registry.example.com/bering:v0.1.0 help
43+
docker pull ghcr.io/mb3r-lab/bering:v0.2.0
44+
docker run --rm ghcr.io/mb3r-lab/bering:v0.2.0 help
4545
```
4646

4747
The release manifest records all published image references and the final digest in `oci_images`.
4848

4949
## OCI Helm Chart
5050

51-
Install directly from an OCI registry:
51+
Install directly from the published OCI chart:
5252

5353
```bash
54-
helm install bering oci://registry.example.com/charts/bering --version 0.1.0
54+
helm install bering oci://ghcr.io/mb3r-lab/charts/bering --version 0.2.0
5555
```
5656

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

5959
```bash
60-
helm install bering oci://registry.example.com/charts/bering --version 0.1.0 \
61-
--set image.repository=registry.example.com/bering \
60+
helm install bering oci://ghcr.io/mb3r-lab/charts/bering --version 0.2.0 \
61+
--set image.repository=ghcr.io/mb3r-lab/bering \
6262
--set image.digest=sha256:...
6363
```
6464

@@ -67,7 +67,7 @@ helm install bering oci://registry.example.com/charts/bering --version 0.1.0 \
6767
Download `bering-contracts_<version>.tar.gz` to consume the public schema contracts offline:
6868

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

docs/schema-publishing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ This workflow is separate from the product release workflow:
99
- product release tags: `vX.Y.Z`
1010
- schema publishing tags: `schema-vA.B.C`
1111

12-
For the first public product release, that means:
12+
For the current release line, that means:
1313

14-
- product release: `v0.1.0`
14+
- product release: `v0.2.0`
1515
- schema publishing: `schema-v1.0.0`
1616

1717
## One-time repository setup

0 commit comments

Comments
 (0)