[PR #19908] [MERGED] Closes #19713: Enable recording user messages in the change log #15755

Closed
opened 2025-12-30 00:23:51 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/19908
Author: @jeremystretch
Created: 7/17/2025
Status: Merged
Merged: 7/29/2025
Merged by: @jnovinger

Base: featureHead: 19713-objectchange-message


📝 Commits (10+)

  • aaaf346 Add message field to ObjectChange model
  • 5e5c46f Set max length on changelog message
  • 8d54368 Enable changelog messages for single object operations
  • 1b11895 Fix tests
  • 0703fe7 Add changelog message support for bulk edit & bulk delete
  • 2044802 Cosmetic improvements to form fields
  • 0514bb4 Fix bulk operation templates
  • f600429 Add message support for bulk import/update
  • ac26665 Add REST API support for changelog messages (WIP)
  • 1615a36 Fix changelog_message assignment

📊 Changes

50 files changed (+576 additions, -185 deletions)

View changed files

📝 docs/features/change-logging.md (+6 -0)
📝 docs/integrations/rest-api.md (+22 -0)
📝 netbox/core/api/serializers_/change_logging.py (+2 -1)
📝 netbox/core/filtersets.py (+2 -1)
netbox/core/migrations/0017_objectchange_message.py (+16 -0)
📝 netbox/core/models/change_logging.py (+6 -0)
📝 netbox/core/signals.py (+24 -0)
📝 netbox/core/tables/change_logging.py (+7 -1)
📝 netbox/core/tests/test_changelog.py (+32 -0)
📝 netbox/core/tests/test_filtersets.py (+1 -1)
📝 netbox/dcim/api/serializers_/devicetype_components.py (+15 -11)
📝 netbox/dcim/forms/bulk_edit.py (+15 -10)
📝 netbox/dcim/forms/model_forms.py (+2 -1)
📝 netbox/dcim/forms/object_create.py (+5 -0)
📝 netbox/dcim/views.py (+1 -1)
📝 netbox/extras/api/serializers_/configcontexts.py (+2 -2)
📝 netbox/extras/api/serializers_/configtemplates.py (+2 -2)
📝 netbox/extras/api/serializers_/customfields.py (+3 -3)
📝 netbox/extras/api/serializers_/customlinks.py (+2 -2)
📝 netbox/extras/api/serializers_/exporttemplates.py (+2 -2)

...and 30 more files

📄 Description

Closes: #19713

  • Add a message field on the ObjectChange model
  • Add a changelog_message field to the object edit & delete forms
  • Capture the changelog_message value on the resulting ObjectChange record when an object is saved or deleted via the web UI
  • Expand the search filter for ObjectChange to match against the message value
  • Expand all model forms & serializers to support changelog messages as appropriate
  • Add the changelog_message field to the necessary view templates
  • Define fieldsets on VirtualChassisCreateForm & discontinue use of the custom HTML template (to ensure consistent display of the changelog message field form)
  • Extend object & bulk views to support changelog messages
  • Extend the view and REST API test suite to validate the changelog message functionality for all create/edit/delete operations
  • Document the new changelog message functionality

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/19908 **Author:** [@jeremystretch](https://github.com/jeremystretch) **Created:** 7/17/2025 **Status:** ✅ Merged **Merged:** 7/29/2025 **Merged by:** [@jnovinger](https://github.com/jnovinger) **Base:** `feature` ← **Head:** `19713-objectchange-message` --- ### 📝 Commits (10+) - [`aaaf346`](https://github.com/netbox-community/netbox/commit/aaaf346e5ff8ef7fed5c627399d460575aac53f5) Add message field to ObjectChange model - [`5e5c46f`](https://github.com/netbox-community/netbox/commit/5e5c46f77c4115c5b1a85ec275ae083bdbca284e) Set max length on changelog message - [`8d54368`](https://github.com/netbox-community/netbox/commit/8d5436876ed2ef7c5321864b689d7edd1fc87de5) Enable changelog messages for single object operations - [`1b11895`](https://github.com/netbox-community/netbox/commit/1b11895c90d726124b603ba1fdf5ffeb1f47eed0) Fix tests - [`0703fe7`](https://github.com/netbox-community/netbox/commit/0703fe78526bab5ec144743d6f713d7adc6a6a6b) Add changelog message support for bulk edit & bulk delete - [`2044802`](https://github.com/netbox-community/netbox/commit/2044802586d700ed02e148a4976743c9dfcbde02) Cosmetic improvements to form fields - [`0514bb4`](https://github.com/netbox-community/netbox/commit/0514bb4e600479e123833ff28a104bbe7b5f0642) Fix bulk operation templates - [`f600429`](https://github.com/netbox-community/netbox/commit/f600429b7e933e972f319c8f3916d10f0bff6968) Add message support for bulk import/update - [`ac26665`](https://github.com/netbox-community/netbox/commit/ac26665f298b9b56c973e7c48d487e24b2176203) Add REST API support for changelog messages (WIP) - [`1615a36`](https://github.com/netbox-community/netbox/commit/1615a369f90d1cc5fe00931baddc9d5bbdfbe781) Fix changelog_message assignment ### 📊 Changes **50 files changed** (+576 additions, -185 deletions) <details> <summary>View changed files</summary> 📝 `docs/features/change-logging.md` (+6 -0) 📝 `docs/integrations/rest-api.md` (+22 -0) 📝 `netbox/core/api/serializers_/change_logging.py` (+2 -1) 📝 `netbox/core/filtersets.py` (+2 -1) ➕ `netbox/core/migrations/0017_objectchange_message.py` (+16 -0) 📝 `netbox/core/models/change_logging.py` (+6 -0) 📝 `netbox/core/signals.py` (+24 -0) 📝 `netbox/core/tables/change_logging.py` (+7 -1) 📝 `netbox/core/tests/test_changelog.py` (+32 -0) 📝 `netbox/core/tests/test_filtersets.py` (+1 -1) 📝 `netbox/dcim/api/serializers_/devicetype_components.py` (+15 -11) 📝 `netbox/dcim/forms/bulk_edit.py` (+15 -10) 📝 `netbox/dcim/forms/model_forms.py` (+2 -1) 📝 `netbox/dcim/forms/object_create.py` (+5 -0) 📝 `netbox/dcim/views.py` (+1 -1) 📝 `netbox/extras/api/serializers_/configcontexts.py` (+2 -2) 📝 `netbox/extras/api/serializers_/configtemplates.py` (+2 -2) 📝 `netbox/extras/api/serializers_/customfields.py` (+3 -3) 📝 `netbox/extras/api/serializers_/customlinks.py` (+2 -2) 📝 `netbox/extras/api/serializers_/exporttemplates.py` (+2 -2) _...and 30 more files_ </details> ### 📄 Description ### Closes: #19713 - Add a `message` field on the ObjectChange model - Add a `changelog_message` field to the object edit & delete forms - Capture the `changelog_message` value on the resulting ObjectChange record when an object is saved or deleted via the web UI - Expand the search filter for ObjectChange to match against the `message` value - Expand all model forms & serializers to support changelog messages as appropriate - Add the `changelog_message` field to the necessary view templates - Define `fieldsets` on VirtualChassisCreateForm & discontinue use of the custom HTML template (to ensure consistent display of the changelog message field form) - Extend object & bulk views to support changelog messages - Extend the view and REST API test suite to validate the changelog message functionality for all create/edit/delete operations - Document the new changelog message functionality --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-30 00:23:51 +01:00
adam closed this issue 2025-12-30 00:23:51 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#15755