v2.1.0

What's Changed

• Views by @Kircheneer in #64
• Add journaling to Design Builder by @abates in #69
• Feature delices q filterset by @Kircheneer in #82
• feat: ✨ Change status from Design to Design Instance by @chadell in #84
• feat: ✨ Decommissioning Job by @chadell in #85
• fix: 🐛 Fix migrations backwards by @chadell in #96
• fix: 🐛 Decommissioning feature handles attributes that are "properties" and ForeingKeys by @chadell in #98
• fix: 🐛 StatusFieldSerializer incorporartes the ID by @chadell in #103
• Feature delices merge develop by @abates in #112
• feat: ✨ Re Run a Design Job to Update it by @chadell in #99
• Update initial state in load_instance get by @qduk in #113
• fixes navigation by @Kircheneer in #114
• Data Protection: Update and Delete by @chadell in #116
• Prepare Design lifecycle features for develop by @chadell in #131
• tests: add a basic test to check end to end run of the design deployment by @chadell in #137
• Feature delices merge from develop by @abates in #135
• docs: Updated changelog by @abates in #143
• Fix custom fields by @abates in #190
• fix: Fixes most likely issues with attribute collisions by @abates in #192
• Feature delices v2 by @abates in #146
• test: Updated unit tests and minor fixes by @abates in #194
• Docs build fixes and pyproject cleanup by @cmsirbu in #196
• feat: ✨ Import mode for design lifecycle by @chadell in #195
• Prep for version 2.1.0 by @abates in #198
• Release 2.1.0 by @abates in #199

New Contributors

• @qduk made their first contribution in #113

Full Changelog: v2.0.1...v2.1.0

v1.4.1

What's Changed

• Fixes Custom field assignment by @abates in #189
• Fixes most likely issues with attribute collisions by @abates in #191

Full Changelog: v1.4.0...v1.4.1

v2.0.1

What's Changed

• Tests by @abates in #148
• feat: Now allowing direct assignment for many-to-many or using through by @abates in #155
• fix: Corrects missing attributes with explicit !create by @abates in #156
• Fix url typo in design_development.md by @gsnider2195 in #175
• Fix typo in function name in design_development.md by @ehendrickson2 in #177
• added release notes for v2.0 to nav by @ehendrickson2 in #179
• Minor doc update to add get as an action. by @itdependsnetworks in #185
• Updated upper bound for Python version by @abates in #186

New Contributors

• @gsnider2195 made their first contribution in #175
• @ehendrickson2 made their first contribution in #177

Full Changelog: v2.0.0...v2.0.1

v1.4.0

v1.4.0 Release Notes

Release Overview

The 1.4 release of Design Builder introduces new functionality that expands on the deployment mode introduced in 1.3. Pre-existing data (i.e. data not created by a design, or created by one not in deployment mode) can now be imported into a design deployment. This design deployment then owns the lifecycle of that data just like if it had been created by it.

As a compliment on the other end of the lifecycle, the design decommissioning now has a checkbox for delete functionality. By default this is checked, which causes the decommissioning job to function as it did prior to the introduction of this feature. If you uncheck it, the data is unlinked from the design deployment, but not deleted, somewhat like a reverse import.

[v1.4.0] - 2024-07

Added

• Adds import functionality to deployment mode designs
• Adds the possibility to merely unlink and not delete objects associated with a design deployment during decommissioning

v1.3.0

v1.3.0 Release Notes

Release Overview

The 1.3 release of Design Builder introduces a new functionality that complements the traditional deployment mode. The designs, if defined for, can now be deployed with life cycle capacity, so after being created, they can be updated with new input data (indefinitely) and decommissioned (i.e., reverting the data to the original state). This new approach requires of new models to track all the information in the database.

Also, as a complement, the design deployments run with the new mode can (optionally) prevent direct modification of the objects or attributes under control of a design. This means that is an object was created by a device, only the design decommissioning can remove it.

Added

Design Lifecycle by @abates in #162

• Add a new mode that tracks the design deployment providing capacity to updates and decommission (life cycle management)
• Provide data protection (optional) for data that has been created or modified by a design deployment.

Full Changelog: v1.2.0...v1.3.0

v2.0.0

What's Changed

Removed support for Nautobot 1.x from the Design Builder 2.x series.

Full Changelog: v1.1.0...v2.0.0

v1.2.0

What's Changed

Removed support for Nautobot 2 from the Design Builder 1.x series.

Full Changelog: v1.1.0...v1.2.0

v1.1.0

v1.1.0 Release Notes

Release Overview

The 1.1 release of Design Builder mostly includes performance improvements in the implementation system. There is a breaking change related to one-to-one relationships. Prior to the 1.1 release, one-to-one relationships were not saved until after the parent object was saved. The performance optimization work revealed this as a performance issue and now one-to-one relationships are treated as simple foreign keys. Since foreign key saves are not deferred by default, it may now be necessary to explicitly specify deferring the save operation. A new deferred attribute has been introduced that causes design builder to defer saving the foreign-key relationship until after the parent object has been saved. The one known case that is affected by this change is when setting a device primary IP when the IP itself is created as a member of an interface in the same device block. See unit tests and design examples for further explanation.

Additionally, the design.Builder class has been renamed to design.Environment to better reflect what that class does. A Builder alias has been added to Environment for backwards compatibility with a deprecation warning.

[v1.1.0] - 2024-04

Added

• Added deferred attribute to allow deferral of field assignment. See notes in the Changed section.

• Added model_metadata attribute to models. At the moment, this provides the ability to specify additional arguments passed to the save method of models being updated. The known use case for this is in creating Git repositories in Nautobot 1.x where trigger_resync must be False. In the future, additional fields will be added to model_metadata to provide new functionality.

Changed

• Renamed nautobot_design_builder.design.Builder to nautobot_design_builder.Environment - aliased original name with deprecation warning.

• Any designs that set OneToOne relationships (such as device primary_ip4) may now need a deferred: true statement in their design for those fields. Previously, OneToOne relationships were always deferred and this is usually unnecessary. Any deferrals must now be explicit.

• Design reports are now saved to the file report.md for Nautobot 2.x installations.

Full Changelog: v1.0.0...v1.1.0

Version 1.0.0

What's Changed

• docs: Fix logo URL by @abates in #105
• docs: fix documentation URLs in README.md by @abates in #106
• fix: Fixed examples to load and run on Nautobot v2 by @abates in #107
• docs: Migrated examples to https://github.com/nautobot/demo-designs

Full Changelog: v0.4.4...v1.0.0

v0.4.4

Version 0.4.4