add override to remove default tag or branch

Currently there is no way to remove a default branch / tag value for a single repository. This makes it impossible to add a repository by referencing a commit that is not on a branch (hence the branch key cannot be set). We fix this by also allowing the nulltype value null as valid values for both branch and tag. This change is fully backward compatible as the value was not allowed before and also does not change semantics. Signed-off-by: Felix Moessbauer <felix.moessbauer@siemens.com> Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
siemens · Nov 4, 2024 · c1fbbdc · c1fbbdc
1 parent f4ceea7
commit c1fbbdc
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 6 deletions.
diff --git a/docs/format-changelog.rst b/docs/format-changelog.rst
@@ -171,3 +171,13 @@ Added
 ~~~~~
 
 - The key ``artifacts`` is introduced to describe expected build artifacts.
+
+Version 18
+----------
+
+Added
+~~~~~
+
+The repo keys ``tag`` and ``branch`` can now be set to ``null`` to remove
+these properties from the repo. This is needed in case a default value is
+set in the ``defaults`` section that should not apply to a repo.
diff --git a/docs/userguide/project-configuration.rst b/docs/userguide/project-configuration.rst
@@ -346,15 +346,17 @@ Configuration reference
       ``commit``, ``branch`` or ``tag``, the revision you get depends on the
       defaults of the version control system used.
 
-    ``branch``: string [optional]
+    ``branch``: string or nothing (``null``) [optional]
       The upstream branch that should be tracked. If ``commit`` was
       specified, kas checks that the branch contains the commit. If no
       ``commit`` was specified, the head of the upstream branch is checked out.
+      The nothing (``null``) value is used to remove a possible default value.
 
-    ``tag``: string [optional]
+    ``tag``: string or nothing (``null``)  [optional]
       The tag that should be checked out. If a ``commit`` was specified, kas
       checks that the tag points to this commit. This must not be combined
-      with ``branch``.
+      with ``branch``. The nothing (``null``) value is used to remove a
+      possible default value.
 
     ``path``: string [optional]
       The path where the repository is stored.

diff --git a/kas/__version__.py b/kas/__version__.py
@@ -28,5 +28,5 @@
 __version__ = '4.5'
 
 # Please update docs/format-changelog.rst when changing the file version.
-__file_version__ = 17
+__file_version__ = 18
 __compatible_file_version__ = 1
diff --git a/kas/schema-kas.json b/kas/schema-kas.json
@@ -170,10 +170,24 @@
                                 "type": "string"
                             },
                             "branch": {
-                                "type": "string"
+                                "oneOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "type": "null"
+                                    }
+                                ]
                             },
                             "tag": {
-                                "type": "string"
+                                "oneOf": [
+                                    {
+                                        "type": "string"
+                                    },
+                                    {
+                                        "type": "null"
+                                    }
+                                ]
                             },
                             "refspec": {
                                 "type": "string"