Merge branch 'main' into feature

Author: bctiemann

.github/ISSUE_TEMPLATE/01-feature_request.yaml

@@ -1,7 +1,7 @@
 ---
 name: ✨ Feature Request
 description: Propose a new feature or enhancement
-labels: ["type: feature", "status: needs triage"]
+labels: ["app: custom objects", "type: feature", "status: needs triage"]
 body:
   - type: input
     attributes:

.github/ISSUE_TEMPLATE/02-bug_report.yaml

@@ -1,7 +1,7 @@
 ---
 name: 🐛 Bug Report
 description: Report a reproducible bug in the current stable release
-labels: ["type: bug", "status: needs triage"]
+labels: ["app: custom objects", "type: bug", "status: needs triage"]
 body:
   - type: input
     attributes:

.github/ISSUE_TEMPLATE/03-documentation_change.yaml

@@ -1,7 +1,7 @@
 ---
 name: 📖 Documentation Change
 description: Suggest an addition or modification to the plugin's documentation
-labels: ["type: documentation", "status: needs triage"]
+labels: ["app: custom objects", "type: documentation", "status: needs triage"]
 body:
   - type: dropdown
     attributes:

.github/ISSUE_TEMPLATE/04-housekeeping.yaml

@@ -1,7 +1,7 @@
 ---
 name: 🏡 Housekeeping
 description: An internal change pertaining to the codebase itself
-labels: ["type: housekeeping"]
+labels: ["app: custom objects", "type: housekeeping"]
 body:
   - type: textarea
     attributes:

.github/workflows/lint-tests.yaml

@@ -69,7 +69,7 @@ jobs:
         with:
           repository: "netbox-community/netbox"
           path: netbox
-          ref: feature
+          ref: main
       - name: Install netbox-custom-objects
         working-directory: netbox-custom-objects
         run: |

README.md

@@ -6,7 +6,8 @@ You can find further documentation [here](https://github.com/netboxlabs/netbox-c
 
 ## Requirements
 
-* NetBox v4.4-beta or later
+* NetBox v4.4.0 or later
+* (Optional) NetBox Branching 0.7.1 or later
 
 ## Installation
 
@@ -36,6 +37,20 @@ $ ./manage.py migrate
 sudo systemctl restart netbox netbox-rq
 ```
 
+> [!NOTE]
+> If you are using NetBox Custom Objects with NetBox Branching, you need to insert the following into your `configuration.py`. See the docs for a full description of how NetBox Custom Objects currently works with NetBox Branching.  
+
+```
+PLUGINS_CONFIG = {
+    'netbox_branching': {
+        'exempt_models': [
+            'netbox_custom_objects.customobjecttype',
+            'netbox_custom_objects.customobjecttypefield',
+        ],
+    },
+}
+```
+
 ## Known Limitations
 
-The Public Preview of NetBox Custom Objects is under active development as we proceed towards the General Availability release around NetBox 4.4. The best place to look for the latest list of known limitations is the [issues](https://github.com/netboxlabs/netbox-custom-objects/issues) list on the GitHub repository.
+NetBox Custom Objects is now Generally Available which means you can use it in production and migrations to future versions will work. There are many upcoming features including GraphQL support - the best place to see what's on the way is the [issues](https://github.com/netboxlabs/netbox-custom-objects/issues) list on the GitHub repository.

docs/api.md

@@ -168,7 +168,7 @@ The response will include the created object with its assigned ID and additional
 
 ### API output in the browser
 
-As with other NetBox objects, you can also view the API output for given Custom Objects by prepending `api/` to the URL, e.g. `api/plugins/custom-objects/dhcp_scope/`
+As with other NetBox objects, you can also view the API output for given Custom Objects by prepending `api/` to the URL, e.g. `api/plugins/custom-objects/dhcp_scopes/`
 
 ```
 HTTP 200 OK

docs/branching.md

@@ -0,0 +1,24 @@
+# Using NetBox Custom Objects with NetBox Branching
+
+As of version 0.4.0 Custom Objects is _compatible_ with NetBox Branching, but not fully supported. This means that users can safely use both plugins together, but there are some caveats to be aware of. See below to learn how each of the Custom Objects models interacts with NetBox Branching.
+
+> [!NOTE]
+> We are working towards full support for Custom Objects on branches. Keep an eye on the GitHub issues for updates ahead of future releases.  
+
+> [!TIP]
+> If you have any questions the best place to start is on the GitHub [discussions](https://github.com/netboxlabs/netbox-custom-objects/discussions). If you are a NetBox Labs customer, you can also contact support.  
+
+## Custom Object Types and Custom Object Type Fields
+
+Custom Object Types and Custom Object Type fields can be created, updated and deleted on branches, however the changes made on branches will be applied in main. This allows Custom Objects and Branching to be used safely alongside each other, but users should be aware of what this means.
+
+- When you are in an activated branch any creates, updates and deletes you perform on Custom Object Types and Custom Object Type Fields will not show up in the Diff or Changes Ahead views
+- Although you're in an activated branch, these changes will be made directly to main
+- Typically it will be NetBox admins who are altering Custom Object Types and Custom Object Type Fields - we recommend that you experiment in your staging instance until you are satisfied with the modelling and then move them into prod
+
+## Custom Objects
+
+Changes to Custom Objects on branches are disallowed.
+
+- When in an activated branch, users will still be able to see the available Custom Object Types and any Custom Objects that were brought into the branch upon branch creation, but will not be able to interact with them to affect changes on the branch.  
+- This approach was chosen to make sure that users can safely use both Custom Objects and Branching together, while we are working on fuller support.  

docs/changelog.md

@@ -0,0 +1,38 @@
+# Changelog
+
+## 0.4.1
+---
+
+### Bug Fixes
+
+- [#237](https://github.com/netboxlabs/netbox-custom-objects/issues/237) - Incorrect validation error when adding multiple fields pointing to the same Custom Object Type
+- [#251](https://github.com/netboxlabs/netbox-custom-objects/issues/251) - Bulk import broken due to incorrect slug handling
+- [#273](https://github.com/netboxlabs/netbox-custom-objects/issues/273) - `group_name` missing from Custom Object Type serializer
+
+
+## 0.4.0
+---
+
+### New Features
+
+**Limited Branching Compatibility for Custom Objects**
+
+Custom Objects now has limited compatibility with NetBox Branching. Please see the documentation for more details.
+
+### Enhancements
+
+- [#37](https://github.com/netboxlabs/netbox-custom-objects/issues/37) - Limited Branching compatibility for Custom Objects
+- [#42](https://github.com/netboxlabs/netbox-custom-objects/issues/42) - Populate default values for Multi-Object fields
+- [#87](https://github.com/netboxlabs/netbox-custom-objects/issues/87) - Make Custom Object "name" clickable
+- [#150](https://github.com/netboxlabs/netbox-custom-objects/issues/150) - Cannot import created CustomObject (Documentation)
+
+### Bug Fixes
+
+- [#70](https://github.com/netboxlabs/netbox-custom-objects/issues/70) - Incorrect validation message on integer field min/max defaults
+- [#104](https://github.com/netboxlabs/netbox-custom-objects/issues/104) - Bulk edit not possible on fields of type `object`
+- [#105](https://github.com/netboxlabs/netbox-custom-objects/issues/105) - Bulk edit not possible on fields of type `multiobject`
+- [#172](https://github.com/netboxlabs/netbox-custom-objects/issues/172) - Postgres errors on startup
+- [#189](https://github.com/netboxlabs/netbox-custom-objects/issues/189) - Exceptions when creating Custom Objects
+- [#195](https://github.com/netboxlabs/netbox-custom-objects/issues/195) - RecursionError in netbox_custom_objects plugin due to circular dependencies in CustomObjectType Fields
+- [#210](https://github.com/netboxlabs/netbox-custom-objects/issues/210) - Custom Objects plugin visible when logged out
+- [#212](https://github.com/netboxlabs/netbox-custom-objects/issues/212) - Quick Search not working

docs/configuration.md

@@ -0,0 +1,7 @@
+# Configuration Parameters
+
+## `max_custom_object_types`
+
+Default: 50
+
+The maximum number of Custom Object Types that may be created.