(bug) Allow 'version' key in inventory files

When running `bolt project migrate` we don't remove the `version` key if the value is `2`, but we still raise a warning that the `version` key isn't recognized. This amends the inventoryfile schema to include the `version` key so that users don't see a warning. !bug * **Allow 'version' key in inventory files** Bolt now recognizes the `version` configuration in an inventoryfile and doesn't raise a warning that the key is unknown.
puppetlabs · Mar 29, 2021 · 6c60cf6 · 6c60cf6
1 parent a0e78ab
commit 6c60cf6
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/lib/bolt/inventory/options.rb b/lib/bolt/inventory/options.rb
@@ -14,6 +14,7 @@ module Options
         plugin_hooks
         targets
         vars
+        version
       ].freeze
 
       # Definitions used to validate the data.
@@ -124,6 +125,12 @@ module Options
           description: "A map of variables for the group or target.",
           type: Hash,
           _plugin: true
+        },
+        "version" => {
+          description: "The version of the inventoryfile.",
+          type: Integer,
+          _plugin: false,
+          _example: 2
         }
       }.freeze
     end

diff --git a/schemas/bolt-inventory.schema.json b/schemas/bolt-inventory.schema.json
@@ -1403,6 +1403,10 @@
           "$ref": "#/definitions/_plugin"
         }
       ]
+    },
+    "version": {
+      "description": "The version of the inventoryfile.",
+      "type": "integer"
     }
   },
   "oneOf": [
@@ -1449,6 +1453,16 @@
             }
           ]
         },
+        "plugin_hooks": {
+          "oneOf": [
+            {
+              "$ref": "#/definitions/plugin_hooks"
+            },
+            {
+              "$ref": "#/definitions/_plugin"
+            }
+          ]
+        },
         "targets": {
           "oneOf": [
             {