Changelog and Release Notes for 0.16 (#4328)

* Bumped version to 0.16 via poetry * Created changelog.md entries for 0.16 * Created Release Notes for 0.16 * Vale and Markdown Lint fixes for legacy release notes
opsmill · Sep 11, 2024 · a8e46aa · a8e46aa
1 parent 38b2eeb
commit a8e46aa
Show file tree

Hide file tree

Showing 27 changed files with 621 additions and 363 deletions.
diff --git a/.vale/styles/Infrahub/sentence-case.yml b/.vale/styles/Infrahub/sentence-case.yml
@@ -44,6 +44,7 @@ exceptions:
   - IP
   - IPAM
   - IPNetwork
+  - IP Fabric
   - JavaScript
   - JetStream
   - Jinja
@@ -52,6 +53,7 @@ exceptions:
   - NATS
   - Node
   - OpsMill
+  - Pydantic
   - Python
   - RabbitMQ
   - REST

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,55 @@ This project uses [*towncrier*](https://towncrier.readthedocs.io/) and the chang
 
 <!-- towncrier release notes start -->
 
+## [0.16.0](https://github.com/opsmill/infrahub/tree/v0.16.0) - 2024-09-11
+
+### Removed
+
+- Removed isolated branch information from schema topic in the documentation. ([#3968](https://github.com/opsmill/infrahub/issues/3968))
+
+### Added
+
+- Allow adding multiple profiles to an object in the UI. ([#3061](https://github.com/opsmill/infrahub/issues/3061))
+- Added "disabled" attribute to accounts to allow more granular user management. ([#3505](https://github.com/opsmill/infrahub/issues/3505))
+- Added capabilities to manage API tokens in the Infrahub UI. ([#3527](https://github.com/opsmill/infrahub/issues/3527))
+- Added filtering and search to IPAM view. ([#3740](https://github.com/opsmill/infrahub/issues/3740))
+- Add number of prefixes to IPAM tree view. ([#3741](https://github.com/opsmill/infrahub/issues/3741))
+- Allow navigation to related node in list view. ([#3889](https://github.com/opsmill/infrahub/issues/3889))
+- Add support to search a node by human friendly ID within a GraphQL query. ([#3908](https://github.com/opsmill/infrahub/issues/3908))
+- Added DB migrations for objects changed to Generic type in 0.16. ([#3915](https://github.com/opsmill/infrahub/issues/3915))
+- Add clickable items in the Proposed Change list view. ([#3990](https://github.com/opsmill/infrahub/issues/3990))
+- Added the ability to filter out Infrahub internal groups. ([#4027](https://github.com/opsmill/infrahub/issues/4027))
+- Add action button to Repository objects. ([#4066](https://github.com/opsmill/infrahub/issues/4066))
+- Added documentation for creating custom Infrahub Docker images. ([#4077](https://github.com/opsmill/infrahub/issues/4077))
+- Add support for numbers bigger or smaller than signed integers. ([#4179](https://github.com/opsmill/infrahub/issues/4179))
+
+### Changed
+
+- Move GraphQL queries to .infrahub.yml for Repository imports. ([#1938](https://github.com/opsmill/infrahub/issues/1938))
+- Improve UI of Git repository form. ([#3893](https://github.com/opsmill/infrahub/issues/3893))
+- Consistency improvements in Repository interactions. ([#4068](https://github.com/opsmill/infrahub/issues/4068))
+- Enhancements to Repository status reporting. ([#4069](https://github.com/opsmill/infrahub/issues/4069))
+- Simplified the Repository view to only show crucial information. ([#4071](https://github.com/opsmill/infrahub/issues/4071))
+- Increased visibility during Git sync. ([#4072](https://github.com/opsmill/infrahub/issues/4072))
+
+### Fixed
+
+- Add ability to import repositories with default branch other than 'main'. ([#3435](https://github.com/opsmill/infrahub/issues/3435))
+- SchemasLoadAPI should not inherited from SchemaRoot but from BaseModel. ([#3821](https://github.com/opsmill/infrahub/issues/3821))
+- Resolve inconsistencies when loading same schema twice. ([#3892](https://github.com/opsmill/infrahub/issues/3892))
+- HFID of a node is not properly set by `prefetch_relationship` in Python SDK. ([#3900](https://github.com/opsmill/infrahub/issues/3900))
+- Comment input is not cleared upon submission of Proposed Change form. ([#3942](https://github.com/opsmill/infrahub/issues/3942))
+- Can not assign Profile when editing Node in the web UI. ([#3999](https://github.com/opsmill/infrahub/issues/3999))
+- Allow users to add a new generic to an existing node. ([#4051](https://github.com/opsmill/infrahub/issues/4051))
+- Allow users to run artifacts and generators on nodes without name attribute ([#4062](https://github.com/opsmill/infrahub/issues/4062))
+- Allow bare Git URL and automatically add `.git`. ([#4070](https://github.com/opsmill/infrahub/issues/4070))
+- Schema diff view not functioning in branch detail page. ([#4093](https://github.com/opsmill/infrahub/issues/4093))
+- Removed erroneous approval button on Diff view. ([#4094](https://github.com/opsmill/infrahub/issues/4094))
+- Edit node form displays empty input field for mandatory relationship of cardinality many. ([#4102](https://github.com/opsmill/infrahub/issues/4102))
+- GraphQL query does not appear on Detail page. ([#4105](https://github.com/opsmill/infrahub/issues/4105))
+- Do not allow '/' character in repository name to avoid sync failure. ([#4120](https://github.com/opsmill/infrahub/issues/4120))
+- Can't close a comment thread on an Artifact. ([#4189](https://github.com/opsmill/infrahub/issues/4189))
+
 ## [0.15.3](https://github.com/opsmill/infrahub/tree/v0.15.3) - 2024-08-13
 
 ### Added

diff --git a/changelog/3435.fixed.md b/changelog/3435.fixed.md
diff --git a/changelog/3908.added.md b/changelog/3908.added.md
diff --git a/changelog/4051.fixed.md b/changelog/4051.fixed.md
diff --git a/changelog/4062.fixed.md b/changelog/4062.fixed.md
diff --git a/changelog/4120.fixed.md b/changelog/4120.fixed.md
diff --git a/changelog/4179.added.md b/changelog/4179.added.md
diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/diff_view_enhancements.png b/docs/docs/media/release_notes/infrahub_0_16_0/diff_view_enhancements.png
diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/diff_view_enhancements_before.png b/docs/docs/media/release_notes/infrahub_0_16_0/diff_view_enhancements_before.png
diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/hide_auto_generated_groups.png b/docs/docs/media/release_notes/infrahub_0_16_0/hide_auto_generated_groups.png
diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/number_pool.png b/docs/docs/media/release_notes/infrahub_0_16_0/number_pool.png
diff --git a/docs/docs/media/release_notes/infrahub_0_16_0/number_pool_detail.png b/docs/docs/media/release_notes/infrahub_0_16_0/number_pool_detail.png
diff --git a/docs/docs/release-notes/infrahub/release-0_12.mdx b/docs/docs/release-notes/infrahub/release-0_12.mdx
@@ -74,7 +74,7 @@ In the example below, all Interfaces will be guaranteed to be unique based on th
         kind: Parent
 ```
 
-##### min_max / max_count for relationships
+##### `min_max` / `max_count` for relationships
 
 On a relationship of cardinality many, it's now possible to define a minimum or maximum number of peers that should be present.
 
@@ -138,7 +138,7 @@ generics:
 
 ### API / GraphQL
 
-#### New DiffSummary query
+#### New `DiffSummary` query
 
 The GraphQL query `DiffSummary` has been refactored to expose more information, it's now possible to query information about the attributes and the relationships in addition to the nodes.
 The previous version of the Query has been migrated to `DiffSummaryOld` and it will be removed in the next release.

diff --git a/docs/docs/release-notes/infrahub/release-0_13.mdx b/docs/docs/release-notes/infrahub/release-0_13.mdx
@@ -171,7 +171,7 @@ A new namespace `dev` has been introduced and some commands have been renamed in
 
 A new `demo.migrate` command has been introduced to apply the database & schema migrations.
 
-#### Update GraphiQL application
+#### Update GraphQL application
 
 The Graph sandbox (GraphiQL) has been integrated into Infrahub directly to provide a better experience
 and remove the dependencies to an external CDN.

diff --git a/docs/docs/release-notes/infrahub/release-0_14.mdx b/docs/docs/release-notes/infrahub/release-0_14.mdx
@@ -31,7 +31,7 @@ This release focuses on preparing for the open beta by cleaning up and improving
 
 ### Unified storage
 
-#### Resource Manager
+#### Resource manager
 
 The resource manager simplifies resource management and allocation.
 This initial implementation supports IP Prefixes and IP Addresses, with future support for additional resources like VLAN, IDs, and interfaces.
@@ -62,7 +62,7 @@ Applied to the network industry:
 
 The fields that will compose the `human_friendly_id` must be defined in the schema
 
-##### hfid support in GraphQL
+##### `hfid` support in GraphQL
 
 `hfid` can be used as an alternative to the ID in most GraphQL operations, including:
 
@@ -77,7 +77,7 @@ The fields that will compose the `human_friendly_id` must be defined in the sche
 
 We have significantly improved and added new content to the documentation, including a new FAQ section.
 
-## Breaking Changes
+## Breaking changes
 
 ### Remove support for non-isolated branch
 
@@ -86,7 +86,7 @@ Although useful, it posed challenges for operations dependent on other nodes in
 
 All branches now operate in isolated mode by default, similar to branches in Git. A branch need to be rebased to stay in sync with main.
 
-## Migration Guide
+## Migration guide
 
 To migrate your instance of Infrahub to the latest version, please run the following commands and restart all instances of Infrahub.
 

diff --git a/docs/docs/release-notes/infrahub/release-0_15.mdx b/docs/docs/release-notes/infrahub/release-0_15.mdx
@@ -40,7 +40,7 @@ This release focuses on enhancing the user experience and laying the groundwork
 
 ### Schema
 
-#### Schema Validation
+#### Schema validation
 
 Added a new validation to ensure schemas do not require relationships to one another. This will prevent incompatible schemas from being loaded in the future.
 
@@ -58,13 +58,13 @@ When a relationship references a peer model with a parent (identified by a paren
 
 The form component in the frontend has been refactored to provide a better foundation for future features that could not be supported by the previous version.
 
-### Helm Chart
+### Helm chart
 
 #### Upstream charts
 
 The official helm chart to deploy Infrahub now leverages the upstream charts for Neo4j, Redis, and RabbitMQ instead of defining these components directly. This approach provides more flexibility and allows us to use pod settings such as pod affinity.
 
-### Infrahub Sync
+### Infrahub sync
 
 #### Integration with IP Fabric
 
@@ -95,25 +95,25 @@ query {
 The search anywhere bar in the frontend now leverages a dedicated GraphQL query.  
 This new query can search for objects by their UUID, improving search results.
 
-#### Generate Protocol for Core models
+#### Generate `Protocol` for `Core` models
 
 Protocol for the internal models have been introduced to improve typing and type checking across the backend.
 
 #### Drop support for Pydantic V1 & Python 3.9
 
 Internally, Infrahub no longer support Python 3.9 and Pydantic v1.
 
-### Demo Environment
+### Demo environment
 
 #### Cleanup and performance improvement
 
 The script infrastructure_edge.py used to load data in the demo environment has been cleaned up to improve readability and performance. Demo in codespace should start faster now.
 
-#### New Services models
+#### New `Services` models
 
 A new service model has been added to the demo schema
 
-## Migration Guide
+## Migration guide
 
 To migrate your instance of Infrahub to the latest version, please run the following commands and restart all instances of Infrahub.
 

diff --git a/docs/docs/release-notes/infrahub/release-0_15_1.mdx b/docs/docs/release-notes/infrahub/release-0_15_1.mdx
@@ -50,13 +50,13 @@ The parent select is also now hidden if it's not available.
 
 It's displayed and available only of the kind selected can point to an object which we can filter depending on its parent.
 
-### Helm Chart
+### Helm chart
 
-### Infrahub Sync
+### Infrahub sync
 
 ### Other
 
-#### 🐛 Bug Fixes
+#### 🐛 Bug fixes
 
 * Fix disabling fields when it is protected and owned by another user by @bilalabbad in https://github.com/opsmill/infrahub/pull/3838
 * Generic selector fixes to correctly reset values when changing kind or object by @pa-lem in https://github.com/opsmill/infrahub/pull/3837
@@ -67,9 +67,9 @@ It's displayed and available only of the kind selected can point to an object wh
 * Add missing overview docs pages by @petercrocker in https://github.com/opsmill/infrahub/pull/3856
 * Add option to fetch peers nodes in query_peers by @dgarros in https://github.com/opsmill/infrahub/pull/3870
 
-### Demo Environment
+### Demo environment
 
-## Migration Guide
+## Migration guide
 
 To migrate your instance of Infrahub to the latest version, please run the following commands and restart all instances of Infrahub.
 

diff --git a/docs/docs/release-notes/infrahub/release-0_15_2.mdx b/docs/docs/release-notes/infrahub/release-0_15_2.mdx
@@ -36,13 +36,13 @@ We are thrilled to announce the latest release of Infrahub (0.15.2).
 
 ### Frontend
 
-### Helm Chart
+### Helm chart
 
-### Infrahub Sync
+### Infrahub sync
 
 ### Other
 
-#### 🐛 Bug Fixes
+#### 🐛 Bug fixes
 
 - Fix OpenAPI documentation of schema load endpoint @dgarros (#3911)
 - Fix return code when trying to use a restricted namespace @dgarros (#3912)
@@ -52,9 +52,9 @@ We are thrilled to announce the latest release of Infrahub (0.15.2).
 - Fix dot on tree being hidden when there is a very long text, also improve CSS for the tree @bilalabbad (#3958)
 - Fix branch details page open correctly when the branch name contains a `/` @bilalabbad (#3917)
 
-### Demo Environment
+### Demo environment
 
-## Migration Guide
+## Migration guide
 
 To migrate your instance of Infrahub to the latest version, please run the following commands and restart all instances of Infrahub.
 

diff --git a/docs/docs/release-notes/infrahub/release-0_15_3.mdx b/docs/docs/release-notes/infrahub/release-0_15_3.mdx
@@ -34,9 +34,9 @@ We are thrilled to announce the latest release of Infrahub (0.15.3).
 
 ### Frontend
 
-### Helm Chart
+### Helm chart
 
-### Infrahub Sync
+### Infrahub sync
 
 ### Other
 
@@ -59,9 +59,9 @@ We are thrilled to announce the latest release of Infrahub (0.15.3).
   Regenerate the screenshots for the tutorial. ([#4035](https://github.com/opsmill/infrahub/issues/4035))
 - Fix object creation for schema node using enum attribute in uniqueness constraint groups. ([#4054](https://github.com/opsmill/infrahub/issues/4054))
 
-### Demo Environment
+### Demo environment
 
-## Migration Guide
+## Migration guide
 
 To migrate your instance of Infrahub to the latest version, please run the following commands and restart all instances of Infrahub.