diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d1f5992..a07e574 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -189,22 +189,6 @@ jobs: if: "matrix.db-backend == 'mysql'" - name: "Run Tests" run: "poetry run invoke unittest" - changelog: - if: | - contains(fromJson('["develop","ltm-1.6"]'), github.base_ref) && - (github.head_ref != 'main') - runs-on: "ubuntu-22.04" - steps: - - name: "Check out repository code" - uses: "actions/checkout@v4" - with: - fetch-depth: "0" - - name: "Setup environment" - uses: "networktocode/gh-action-setup-poetry-environment@v6" - - name: "Check for changelog entry" - run: | - git fetch --no-tags origin +refs/heads/${{ github.base_ref }}:refs/remotes/origin/${{ github.base_ref }} - poetry run towncrier check --compare-with origin/${{ github.base_ref }} publish_gh: needs: - "unittest" diff --git a/docs/admin/compatibility_matrix.md b/docs/admin/compatibility_matrix.md index 95a41cd..893c20d 100644 --- a/docs/admin/compatibility_matrix.md +++ b/docs/admin/compatibility_matrix.md @@ -2,4 +2,5 @@ | Nautobot Design Builder Version | Nautobot First Support Version | Nautobot Last Support Version | | ------------------------------- | ------------------------------ | ----------------------------- | -| 1.0.X | 1.6.0 | 2.9999 | +| 1.X | 1.6.0 | 1.99.99 | +| 2.X | 2.0.0 | 2.99.99 | diff --git a/docs/admin/release_notes/version_1.2.md b/docs/admin/release_notes/version_1.2.md new file mode 100644 index 0000000..3e5de20 --- /dev/null +++ b/docs/admin/release_notes/version_1.2.md @@ -0,0 +1,15 @@ +# v1.2.0 Release Notes + +## Release Overview + +The 1.2 release of Design Builder removes support for Nautobot 2.x from the long term support branch. Support for Nautobot 1.x will continue in the ltm-1.6 branch while Nautobot 2.0 support will remain in the develop branch. + +## [v1.2.0] - 2024-05 + +### Removed + +- Tests specific to Nautobot 2 + +### Changed + +- No longer implementing any versioning logic to support multiple versions of Nautobot diff --git a/docs/admin/release_notes/version_1.3.md b/docs/admin/release_notes/version_1.3.md new file mode 100644 index 0000000..7d25b51 --- /dev/null +++ b/docs/admin/release_notes/version_1.3.md @@ -0,0 +1,15 @@ +# 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. + +## [v1.3.0] - 2024-06 + +### Added + +- 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. diff --git a/docs/admin/release_notes/version_1.4.md b/docs/admin/release_notes/version_1.4.md new file mode 100644 index 0000000..7fe4461 --- /dev/null +++ b/docs/admin/release_notes/version_1.4.md @@ -0,0 +1,21 @@ +# 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.4.1] - 2024-10 + +### Fixed + +- Fixed custom field updates +- Fixed attribute name collisions with Design Builder reserved attributes (namely `metadata` and `environment`). diff --git a/docs/admin/release_notes/version_2.1.md b/docs/admin/release_notes/version_2.1.md new file mode 100644 index 0000000..e9893d6 --- /dev/null +++ b/docs/admin/release_notes/version_2.1.md @@ -0,0 +1,15 @@ +# v2.1.0 Release Notes + +## Release Overview + +The 2.1.0 release of Design Builder is the first release in the 2.x series to include the design lifecycle features previously introduced in v1.3.0. This feature provides a means to track objects created or updated by designs in a collection of Nautobot objects known as a deployment. These deployments can be managed by re-running the design with new variables, and they can also be decommissioned. Objects and attributes that are owned by a deployment are protected from outside changes. + +## [v2.1.0] - 2024-10 + +### Added + +- Added design deployment mechanism to track objects that are part of a design deployment. + +- Added custom validator to protect objects and attributes that are owned, or managed, by a design deployment. + +- Added the ability to import existing objects into a design deployment. This is particularly useful when a new design should encapsulate objects from a brownfield deployment. diff --git a/nautobot_design_builder/templates/nautobot_design_builder/design_list.html b/nautobot_design_builder/templates/nautobot_design_builder/design_list.html index 21fdc25..e6428ab 100644 --- a/nautobot_design_builder/templates/nautobot_design_builder/design_list.html +++ b/nautobot_design_builder/templates/nautobot_design_builder/design_list.html @@ -36,7 +36,7 @@
-

Design Documentation

+

Design Documentation

diff --git a/pyproject.toml b/pyproject.toml index 19cf933..3e3226d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "nautobot-design-builder" -version = "2.0.1" +version = "2.1.0" description = "Nautobot app that uses design templates to easily create data objects in Nautobot with minimal input from a user." authors = ["Network to Code, LLC "] license = "Apache-2.0"