docs: bring docs and changelog up to 0.17.0 - #128
Merged
Conversation
Up to standards ✅🟢 Issues
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release prep for 0.17.0. No behaviour changes — documentation, CHANGELOG, and two release-process corrections.
Release blocker found
dpp-vocabwas missing from the publishing order inRELEASE.md. It ispublish = true, it is new in this release, anddpp-aasdepends on it — so publishing in the documented order would have tried to releasedpp-aasagainst a crate that does not exist on crates.io yet. Added at position 5, before its dependents, with a note thatjust semver's exclusion for it should be deleted once it has shipped once.Verified while checking:
dpp-registryanddpp-plugin-sdkare absent from[workspace.dependencies]but have no workspace dependents, so no pin is needed. All 12 crates are lockstep at 0.17.0 viaversion.workspace = true.cargo package --listconfirms theinclude_str!-embedded data ships: 14 vocabulary records, 28 schemas, 11 sector manifests.CHANGELOG
Entries added for work that changed behaviour and had none:
carbonFootprintClassprovenance pair — the one case that was actively wrong rather than merely absent.carbonFootprintClassanddueDiligenceUrlbarred 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.x-disclosurefail-open and its build-time guard.One correction: the
v2.6.0Breaking entry saidBatteryData"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.mdwas the worst drift — dated 2026-05-29 and still describingBatteryData v2.0.0.expected_lifetime_cyclesrequired 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.product_categoryexample still offered"laptop", a value feat(domain): narrow electronics to its four 2023/1670 device types #109 deleted.PLUGIN-HOST.mdandCOMPLIANCE.mdbattery schema ranges.dpp-domain/README.md— the headline example usedSectorAccessPolicy::from_catalog, now deprecated, and stated disclosure "comes from the catalog manifests", which stopped being true in #120/#121. Rewritten againstfor_schema_versionwith the versioning rationale. It is doctested and passes.justfile— thesemverrecipe claimed "all five real removals". The merged tree reports seven, across five lints.