docs: add release notes for Schema Library 2.0.0 - #94
Open
BeArchiTek wants to merge 1 commit into
Open
BeArchiTek wants to merge 1 commit into
BeArchiTek wants to merge 1 commit into
Conversation
The repository has published tags but no written account of what changed between them: the v1.4.11 release body is a single sentence and v1.1.8 is empty. The 2.0.0 window covers roughly eleven months and fifteen pull requests, so what changed is currently only recoverable by reading commits. Assemble CHANGELOG.md from news fragments covering the user-facing changes in that window, and add a release-notes page to the documentation site. The page leads with what someone can do differently after upgrading, and carries the migration warning up front: 2.0.0 renames and retypes attributes and relationships across the base schemas and most extensions, so data built on a 1.x schema has to be migrated rather than upgraded in place. Every claim was verified against the schema files at this commit rather than taken from pull request descriptions. Several of those descriptions did not match what shipped — the interface MTU stayed on the DcimInterface generic instead of moving to InterfacePhysical, the IpamPrefix supernet role was dropped rather than kept, and the removal of DcimCircuit.location went unmentioned — so the entries follow the schema files. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Summary
Schema Library has published tags but no written account of what changed between them: the v1.4.11 release body is a single sentence and v1.1.8 is empty. Anyone upgrading from 1.x has to read commits to find out what moved. This assembles the 2.0.0 changelog and adds a release-notes page to the documentation site, so the upgrade path is written down before the tag is cut.
Key Changes
CHANGELOG.mdnow carries a 2.0.0 section, assembled from news fragments covering the user-facing work merged since v1.4.11 (roughly eleven months and fifteen pull requests).Notes for reviewers
Every entry was verified against the schema files on this branch rather than taken from the originating pull request descriptions. Several of those descriptions did not match what shipped, and the entries follow the schema files where they disagreed:
mtumoved toInterfacePhysicalDcimInterfacegeneric; default1514to1500, now optionalIpamPrefix.rolekeepssupernetsupernetis dropped; the set ismanagement,link,customer,backboneSnmpClient.ip_addressip_addressesis_privateprivateGenericVLANIpamGenericVLAN, defined inextensions/vlanhotswappablehot_swappable, onDcimPSUModule/DcimPSUModuleTypeDcimCircuit.locationwas removed; location now lives on the endpointload_demo_ipam_dciminvoke task was addedtasks/schemas.py, so it is not claimedTwo judgement calls worth a second opinion:
Documentation Updates
docs/docs/release-notes/v2.0.0.mdx— new pagedocs/sidebars.ts— Release notes category addedTest Plan
uv run invoke docs.build— builds clean, zero broken links or anchorsCHANGELOG.mdand the new page — cleandocs/— 0 errors, 0 warningsmarkdown-lintandvalidate-documentationCI jobsAssisted-by: opsmill-docs-writing-release-notes 0.1.0
Assisted-by: opsmill-dev-commit 0.1.0
Assisted-by: opsmill-dev-pr 0.2.0