Display label refactoring (#62)

* First round of refactoring

* Move to UV

* Add explicit latest infrahub version

* Simplify display label

* Cleanup CI

* Cleanup

Author: BaptisteGi

.github/workflows/ci.yml

@@ -71,10 +71,18 @@ jobs:
     steps:
       - name: "Check out repository code"
         uses: "actions/checkout@v4"
-      - name: "Setup environment"
-        run: "pip install yamllint==1.35.1"
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: "Install uv"
+        uses: "astral-sh/setup-uv@v5"
+        with:
+          version: "0.9.18"
+      - name: Install dependencies
+        run: uv sync --group dev
       - name: "Linting: yamllint"
-        run: "yamllint -s ."
+        run: "uv run yamllint -s ."
 
   markdown-lint:
     name: Run markdown lint
@@ -108,6 +116,7 @@ jobs:
       group: huge-runners
     env:
       INFRAHUB_API_TOKEN: 06438eb2-8019-4776-878c-0941b1f1d1ec
+      INFRAHUB_VERSION: latest
     steps:
       - name: Check out repository code
         uses: actions/checkout@v4
@@ -195,7 +204,6 @@ jobs:
         uses: "actions/checkout@v4"
         with:
           submodules: true
-
       # The official GitHub Action for Vale doesn't work, installing manually instead:
       # https://github.com/errata-ai/vale-action/issues/103
       - name: Download Vale

.gitignore

@@ -3,3 +3,7 @@
 .env
 test.sh
 __pycache__
+
+# uv
+.venv/
+.python-version

base/dcim.yml

@@ -12,8 +12,7 @@ generics:
       - name__value
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     attributes:
       - name: name
         kind: Text
@@ -128,8 +127,7 @@ generics:
     description: "Generic Network Interface"
     label: Interface
     include_in_menu: false
-    display_labels:
-      - name__value
+    display_label: name__value
     order_by:
       - device__name__value
       - name__value
@@ -310,8 +308,7 @@ nodes:
     icon: mdi:poll
     human_friendly_id:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     order_by:
       - manufacturer__name__value
       - name__value
@@ -373,8 +370,7 @@ nodes:
     icon: mdi:application-cog-outline
     human_friendly_id:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     order_by:
       - manufacturer__name__value
       - name__value

base/ipam.yml

@@ -12,8 +12,7 @@ nodes:
     include_in_menu: false
     order_by:
       - address__value
-    display_labels:
-      - address__value
+    display_label: address__value
     inherit_from:
       - BuiltinIPAddress
     uniqueness_constraints:
@@ -42,8 +41,7 @@ nodes:
     label: Prefix
     order_by:
       - prefix__value
-    display_labels:
-      - prefix__value
+    display_label: prefix__value
     inherit_from:
       - BuiltinIPPrefix
     uniqueness_constraints:

base/location.yml

@@ -14,8 +14,7 @@ generics:
       - shortname__value
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     attributes:
       - name: name
         kind: Text
@@ -39,6 +38,13 @@ generics:
     namespace: Location
     description: Location directly hosting device and services.
     include_in_menu: false
+    human_friendly_id:
+      - shortname__value
+    attributes:
+      - name: shortname
+        kind: Text
+        unique: true
+        order_weight: 1100
     # This is only owning relationships toward various assets that could be found on those locations
     relationships:
       - name: prefixes

base/organization.yml

@@ -11,8 +11,7 @@ generics:
       - name__value
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     icon: mdi:domain
     include_in_menu: true
     attributes:

experimental/azure/azure.yml

@@ -25,18 +25,15 @@ nodes:
   - name: Location
     namespace: Azure
     menu_placement: AzureResource
-    display_labels:
-      - name__value
+    display_label: name__value
     attributes:
       - name: name
         kind: Text
 
   - name: Tenant
     namespace: Azure
     menu_placement: AzureResource
-    display_labels:
-      - name__value
-      - tenant_id__value
+    display_label: "{{ name__value }} (Tenant ID: {{ tenant_id__value }})"
     attributes:
       - name: name
         kind: Text
@@ -51,9 +48,7 @@ nodes:
   - name: Subscription
     namespace: Azure
     menu_placement: AzureResource
-    display_labels:
-      - name__value
-      - subscription_id__value
+    display_label: "{{ name__value }} (Subscription ID: {{ subscription_id__value }})"
     attributes:
       - name: name
         kind: Text
@@ -73,8 +68,7 @@ nodes:
   - name: ResourceGroup
     namespace: Azure
     menu_placement: AzureResource
-    display_labels:
-      - name__value
+    display_label: name__value
     attributes:
       - name: name
         kind: Text
@@ -93,8 +87,7 @@ nodes:
     label: "Virtual Networks"
     namespace: Azure
     menu_placement: AzureResource
-    display_labels:
-      - name__value
+    display_label: name__value
     inherit_from:
       - AzureResource
     relationships:
@@ -112,8 +105,7 @@ nodes:
     namespace: Azure
     menu_placement: AzureResource
     include_in_menu: true
-    display_labels:
-      - name__value
+    display_label: name__value
     attributes:
       - name: name
         kind: Text

experimental/circuit_service/circuit_service.yml

@@ -12,8 +12,7 @@ nodes:
       - name__value
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     attributes:
       - name: name
         kind: Text

experimental/infiniband/infiniband.yml

@@ -12,8 +12,7 @@ nodes:
       - "CoreArtifactTarget"
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     attributes:
       - name: name
         kind: Text
@@ -136,8 +135,7 @@ nodes:
     human_friendly_id: ["switch__name__value", "name__value"]
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     uniqueness_constraints:
       - ["switch", "name__value"]
     attributes:
@@ -248,8 +246,7 @@ nodes:
     human_friendly_id: ["switch__name__value", "name__value"]
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     uniqueness_constraints:
       - ["switch", "name__value"]
     attributes:
@@ -297,8 +294,7 @@ nodes:
     human_friendly_id: ["description__value"]
     order_by:
       - speed__value
-    display_labels:
-      - speed__value
+    display_label: speed__value
     attributes:
       - name: speed
         kind: Dropdown
@@ -337,8 +333,7 @@ nodes:
     icon: "mdi:network"
     order_by:
       - identifier__value
-    display_labels:
-      - identifier__value
+    display_label: identifier__value
     uniqueness_constraints:
       - ["identifier__value"]
     attributes:
@@ -375,8 +370,7 @@ nodes:
       - "CoreArtifactTarget"
     order_by:
       - name__value
-    display_labels:
-      - name__value
+    display_label: name__value
     attributes:
       - name: name
         kind: Text

experimental/location_extended/location_extended.yml

@@ -10,8 +10,7 @@ nodes:
     include_in_menu: true
     menu_placement: "LocationGeneric"
     label: Continent
-    display_labels:
-      - name__value
+    display_label: name__value
     parent: ""
     children: "LocationCountry"
     icon: "jam:world"
@@ -21,8 +20,7 @@ nodes:
     include_in_menu: true
     menu_placement: "LocationGeneric"
     label: Country
-    display_labels:
-      - name__value
+    display_label: name__value
     parent: "LocationContinent"
     children: "LocationRegion"
     icon: "gis:search-country"
@@ -32,8 +30,7 @@ nodes:
     include_in_menu: true
     menu_placement: "LocationGeneric"
     label: Region
-    display_labels:
-      - name__value
+    display_label: name__value
     parent: "LocationCountry"
     children: "LocationMetro"
     icon: "carbon:cics-region-target"
@@ -43,8 +40,7 @@ nodes:
     include_in_menu: true
     menu_placement: "LocationGeneric"
     label: Metro
-    display_labels:
-      - name__value
+    display_label: name__value
     parent: "LocationRegion"
     children: "LocationBuilding"
     icon: "healthicons:city"
@@ -54,8 +50,7 @@ nodes:
     include_in_menu: true
     menu_placement: "LocationGeneric"
     label: Building
-    display_labels:
-      - name__value
+    display_label: name__value
     parent: "LocationMetro"
     children: "LocationFloor"
     icon: "ri:building-line"
@@ -81,8 +76,7 @@ nodes:
     include_in_menu: true
     menu_placement: "LocationGeneric"
     label: Floor
-    display_labels:
-      - name__value
+    display_label: name__value
     parent: "LocationBuilding"
     icon: "mdi:home-floor-0"
     children: "LocationSuite"
@@ -92,8 +86,7 @@ nodes:
     include_in_menu: true
     menu_placement: "LocationGeneric"
     label: Suite
-    display_labels:
-      - name__value
+    display_label: name__value
     parent: "LocationFloor"
     children: "LocationRack"
     icon: "game-icons:cage"
@@ -114,8 +107,7 @@ nodes:
     include_in_menu: true
     menu_placement: "LocationGeneric"
     label: Rack
-    display_labels:
-      - name__value
+    display_label: name__value
     human_friendly_id:
       - shortname__value
     parent: "LocationSuite"