Merge branch 'main' into feature

Author: jeremystretch

.hooks/mkdocs-build.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -euo pipefail
+
+echo "Running mkdocs build..."
+
+TEMP_SITE_DIR=$(mktemp -d)
+
+# Run mkdocs build into temp dir
+if mkdocs build --site-dir "$TEMP_SITE_DIR" --strict; then
+    echo "Build successful."
+else
+    echo "Build failed." >&2
+    exit 1
+fi
+
+# Cleanup
+rm -rf "$TEMP_SITE_DIR"

.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.11.12
+  hooks:
+    - id: ruff
+      name: "Ruff linter"
+      args: [ netbox_branching/ ]
+- repo: local
+  hooks:
+    - id: mkdocs-build
+      name: "Build documentation"
+      description: "Build the documentation with mkdocs"
+      files: 'docs/'
+      entry: .hooks/mkdocs-build.sh
+      language: system
+      pass_filenames: false

docs/changelog.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## v0.5.6
+
+### Enhancements
+
+* [#262](https://github.com/netboxlabs/netbox-branching/issues/262) - Copy migrations table when provisioning a branch
+
+### Bug Fixes
+
+* [#256](https://github.com/netboxlabs/netbox-branching/issues/256) - Fix "changes ahead" count on branches pending provisioning
+* [#260](https://github.com/netboxlabs/netbox-branching/issues/260) - Ignore duplicate SQL indexes when provisioning a branch
+* [#275](https://github.com/netboxlabs/netbox-branching/issues/275) - Set `sync_time` on branch during initial provisioning
+
+---
+
 ## v0.5.5
 
 ### Bug Fixes

netbox_branching/__init__.py

@@ -11,7 +11,7 @@ class AppConfig(PluginConfig):
     name = 'netbox_branching'
     verbose_name = 'NetBox Branching'
     description = 'A git-like branching implementation for NetBox'
-    version = '0.5.5'
+    version = '0.5.6'
     base_url = 'branching'
     min_version = '4.2.3'
     middleware = [

netbox_branching/models/branches.py

@@ -136,10 +136,6 @@ def schema_name(self):
     def connection_name(self):
         return f'schema_{self.schema_name}'
 
-    @property
-    def synced_time(self):
-        return self.last_sync or self.created
-
     def clean(self):
 
         # Enforce the maximum number of total branches
@@ -222,32 +218,36 @@ def get_unsynced_changes(self):
         """
         Return a queryset of all ObjectChange records created in main since the Branch was last synced or created.
         """
-        if self.status not in BranchStatusChoices.WORKING:
-            return ObjectChange.objects.none()
-        return ObjectChange.objects.using(DEFAULT_DB_ALIAS).exclude(
-            application__branch=self
-        ).filter(
-            changed_object_type__in=get_branchable_object_types(),
-            time__gt=self.synced_time
-        )
+        # TODO: Remove this fallback logic in a future release
+        # Backward compatibility for branches created before v0.5.6, which did not have last_sync set automatically
+        # upon provisioning. Defaults to the branch creation time.
+        last_sync = self.last_sync or self.created
+        if self.status == BranchStatusChoices.READY:
+            return ObjectChange.objects.using(DEFAULT_DB_ALIAS).exclude(
+                application__branch=self
+            ).filter(
+                changed_object_type__in=get_branchable_object_types(),
+                time__gt=last_sync
+            )
+        return ObjectChange.objects.none()
 
     def get_unmerged_changes(self):
         """
         Return a queryset of all unmerged ObjectChange records within the Branch schema.
         """
-        if self.status not in BranchStatusChoices.WORKING:
-            return ObjectChange.objects.none()
-        return ObjectChange.objects.using(self.connection_name)
+        if self.status == BranchStatusChoices.READY:
+            return ObjectChange.objects.using(self.connection_name)
+        return ObjectChange.objects.none()
 
     def get_merged_changes(self):
         """
         Return a queryset of all merged ObjectChange records for the Branch.
         """
-        if self.status not in (BranchStatusChoices.MERGED, BranchStatusChoices.ARCHIVED):
-            return ObjectChange.objects.none()
-        return ObjectChange.objects.using(DEFAULT_DB_ALIAS).filter(
-            application__branch=self
-        )
+        if self.status in (BranchStatusChoices.MERGED, BranchStatusChoices.ARCHIVED):
+            return ObjectChange.objects.using(DEFAULT_DB_ALIAS).filter(
+                application__branch=self
+            )
+        return ObjectChange.objects.none()
 
     def get_event_history(self):
         history = []
@@ -269,10 +269,13 @@ def is_stale(self):
         """
         Indicates whether the branch is too far out of date to be synced.
         """
+        if self.last_sync is None:
+            # Branch has not yet been provisioned
+            return False
         if not (changelog_retention := get_config().CHANGELOG_RETENTION):
             # Changelog retention is disabled
             return False
-        return self.synced_time < timezone.now() - timedelta(days=changelog_retention)
+        return self.last_sync < timezone.now() - timedelta(days=changelog_retention)
 
     #
     # Branch action indicators
@@ -718,7 +721,10 @@ def provision(self, user):
 
         logger.info('Provisioning completed')
 
-        Branch.objects.filter(pk=self.pk).update(status=BranchStatusChoices.READY)
+        Branch.objects.filter(pk=self.pk).update(
+            status=BranchStatusChoices.READY,
+            last_sync=timezone.now(),
+        )
         BranchEvent.objects.create(branch=self, user=user, type=BranchEventTypeChoices.PROVISIONED)
 
     provision.alters_data = True

netbox_branching/templates/netbox_branching/branch.html

@@ -83,13 +83,17 @@ <h5 class="card-header">{% trans "Branch" %}</h5>
           <tr>
             <th scope="row">{% trans "Last synced" %}</th>
             <td>
-              {{ object.synced_time|isodatetime }}
-              {% if object.is_stale %}
-                <span class="text-danger" title="{% trans "Branch is stale and can no longer be synced" %}">
-                  <i class="mdi mdi-alert-circle"></i>
-                </span>
+              {% if object.last_sync %}
+                {{ object.last_sync|isodatetime }}
+                {% if object.is_stale %}
+                  <span class="text-danger" title="{% trans "Branch is stale and can no longer be synced" %}">
+                    <i class="mdi mdi-alert-circle"></i>
+                  </span>
+                {% endif %}
+                <div class="small text-muted">{{ object.last_sync|timesince }} {% trans "ago" %}</div>
+              {% else %}
+                {{ ''|placeholder }}
               {% endif %}
-              <div class="small text-muted">{{ object.synced_time|timesince }} {% trans "ago" %}</div>
             </td>
           </tr>
           <tr>

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "netboxlabs-netbox-branching"
-version = "0.5.5"
+version = "0.5.6"
 description = "A git-like branching implementation for NetBox"
 readme = "README.md"
 requires-python = ">=3.10"