Skip to content

Commit 471fcd7

Browse files
gnidantest
authored andcommitted
docs: record the identification field in the changelogs
1 parent 7f04479 commit 471fcd7

3 files changed

Lines changed: 39 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,27 @@ The sections do not signal obligations; the prefixes do.
5353

5454
## Unreleased
5555

56+
### Added
57+
58+
- An `ethdebug` field on **ethdebug/format/info**,
59+
**ethdebug/format/info/resources** and **ethdebug/format/program** names
60+
the schema the object conforms to and the specification version that
61+
defines it, through the new **ethdebug/format/data/identification**
62+
schema. The field is optional now and becomes required at `0.1.0`. An
63+
object without it predates the field ([#305]).
64+
- Schemas: **ethdebug/format/data/identification**,
65+
**ethdebug/format/info**, **ethdebug/format/info/resources**,
66+
**ethdebug/format/program**
67+
- Producers: optional: emit `ethdebug: { schema, version }` with the
68+
version of the specification whose schemas the producer targets; a
69+
program inside a container may omit it, and when both carry it the
70+
versions must be equal.
71+
- Consumers: optional: a consumer may read the field.
72+
**ethdebug/format/program** and **ethdebug/format/info** are closed
73+
objects (`unevaluatedProperties: false`), so a consumer that
74+
validates against the previous release's schemas rejects an
75+
identified object until it updates its schemas.
76+
5677
## 0.1.0-draft.0 — 2026-09-21
5778

5879
The version scheme changed: prerelease versions of the specification are now
@@ -616,3 +637,4 @@ First published version of the specification.
616637
[#285]: https://github.com/ethdebug/format/pull/285
617638
[#286]: https://github.com/ethdebug/format/pull/286
618639
[#303]: https://github.com/ethdebug/format/pull/303
640+
[#305]: https://github.com/ethdebug/format/pull/305

‎packages/bugc/CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ support. Changes to the specification itself are tracked in the root
77

88
## Unreleased
99

10+
### Changed
11+
12+
- Every program `bugc` emits now carries an `ethdebug` field naming
13+
**ethdebug/format/program** and the `@ethdebug/format` version `bugc`
14+
was built against ([#305]).
15+
1016
## 0.1.0-preview.0 — 2026-09-21
1117

1218
The version scheme changed: prerelease versions are now `preview.<n>`, and
@@ -35,3 +41,4 @@ First publication.
3541
[#286]: https://github.com/ethdebug/format/pull/286
3642
[#298]: https://github.com/ethdebug/format/pull/298
3743
[#300]: https://github.com/ethdebug/format/pull/300
44+
[#305]: https://github.com/ethdebug/format/pull/305

‎packages/format/CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ tracked in the root [`CHANGELOG.md`](../../CHANGELOG.md).
66

77
## Unreleased
88

9+
### Added
10+
11+
- `version`, the package's own version string, generated at build time from
12+
`package.json` ([#305]).
13+
- `Data.Identification` and `Data.isIdentification`, the type and guard for
14+
the new **ethdebug/format/data/identification** schema;
15+
`identify(schema)` builds one from `version` ([#305]).
16+
- `Program.ethdebug`, an optional `Data.Identification` ([#305]).
17+
918
## 0.1.0-draft.0 — 2026-09-21
1019

1120
The version scheme changed: prerelease versions are now `draft.<n>`, matching
@@ -116,6 +125,7 @@ First publication.
116125
[#293]: https://github.com/ethdebug/format/pull/293
117126
[#300]: https://github.com/ethdebug/format/pull/300
118127
[#303]: https://github.com/ethdebug/format/pull/303
128+
[#305]: https://github.com/ethdebug/format/pull/305
119129
[`0ef2f37`]: https://github.com/ethdebug/format/commit/0ef2f37
120130
[`10ab103`]: https://github.com/ethdebug/format/commit/10ab103
121131
[`21e532e`]: https://github.com/ethdebug/format/commit/21e532e

0 commit comments

Comments
 (0)