Skip to content

docs: bring docs and changelog up to 0.17.0 - #128

Merged
LKSNDRTMLKV merged 1 commit into
mainfrom
chore/release-prep-0-17
Aug 13, 2026
Merged

docs: bring docs and changelog up to 0.17.0#128
LKSNDRTMLKV merged 1 commit into
mainfrom
chore/release-prep-0-17

Conversation

@LKSNDRTMLKV

Copy link
Copy Markdown
Member

Release prep for 0.17.0. No behaviour changes — documentation, CHANGELOG, and two release-process corrections.

Release blocker found

dpp-vocab was missing from the publishing order in RELEASE.md. It is publish = true, it is new in this release, and dpp-aas depends on it — so publishing in the documented order would have tried to release dpp-aas against a crate that does not exist on crates.io yet. Added at position 5, before its dependents, with a note that just semver's exclusion for it should be deleted once it has shipped once.

Verified while checking: dpp-registry and dpp-plugin-sdk are absent from [workspace.dependencies] but have no workspace dependents, so no pin is needed. All 12 crates are lockstep at 0.17.0 via version.workspace = true. cargo package --list confirms the include_str!-embedded data ships: 14 vocabulary records, 28 schemas, 11 sector manifests.

CHANGELOG

Entries added for work that changed behaviour and had none:

  • The battery AAS submodel now projects 17 previously-dropped fields, including the carbonFootprintClass provenance pair — the one case that was actively wrong rather than merely absent.
  • carbonFootprintClass and dueDiligenceUrl barred as the guidance defers them, and the note that this is a different axis from disclosure — the same field is public when it is eventually filled.
  • All 71 guidance data points now accounted for, replacing the previous "not classified row by row".
  • The misspelt-x-disclosure fail-open and its build-time guard.
  • The textile schema-parity fixture.

One correction: the v2.6.0 Breaking entry said BatteryData "gains three fields". Across this release it goes from 37 to 68, with none removed. A downstream reader updating exhaustive struct literals needs the real scope.

Docs

DATA-MODEL.md was the worst drift — dated 2026-05-29 and still describing BatteryData v2.0.0.

  • §4.1 rewritten. It listed 27 fields against a type that now has 68, marked expected_lifetime_cycles required when v2.6.0 relaxed it, and repeated the "at 50% SoC" qualifier this release established was invented. Rather than re-copying 68 rows, it now documents shape — the four Annex XIII tiers, the nested point-4 blocks, the legacy fields — and points at the type and schema as authoritative. A hand-maintained duplicate of the struct is the same drift that left four fields unvalidatable for seven schema versions.
  • Electronics product_category example still offered "laptop", a value feat(domain): narrow electronics to its four 2023/1670 device types #109 deleted.
  • Schema inventory said 5 versions; there are 28.
  • PLUGIN-HOST.md and COMPLIANCE.md battery schema ranges.

dpp-domain/README.md — the headline example used SectorAccessPolicy::from_catalog, now deprecated, and stated disclosure "comes from the catalog manifests", which stopped being true in #120/#121. Rewritten against for_schema_version with the versioning rationale. It is doctested and passes.

justfile — the semver recipe claimed "all five real removals". The merged tree reports seven, across five lints.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@LKSNDRTMLKV
LKSNDRTMLKV merged commit 94eeaaf into main Aug 13, 2026
16 checks passed
@LKSNDRTMLKV
LKSNDRTMLKV deleted the chore/release-prep-0-17 branch August 13, 2026 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant