#128 - Allow to skip patch version in input assuming 0 (#158)

* #128 - Allow to skip patch version in input assuming 0
- tag and from-tag inputs can be now defined as short versions. The `.0` is added automatically.

Author: miroslavpojer

README.md

@@ -102,8 +102,8 @@ Add the following step to your GitHub workflow (in example are used non-default
   env:
     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  
   with:
-    tag-name: "v0.2.0"
-    from-tag-name: "v0.1.0"
+    tag-name: "v0.2.0"                        # accepts also v0.2 format when patch version is 0
+    from-tag-name: "v0.1.0"                   # accepts also v0.1 format when patch version is 0
     chapters: |
       - {"title": "Breaking Changes 💥", "label": "breaking-change"}
       - {"title": "New Features 🎉", "label": "enhancement"}

release_notes_generator/action_inputs.py

@@ -52,6 +52,7 @@
 )
 from release_notes_generator.utils.enums import DuplicityScopeEnum
 from release_notes_generator.utils.gh_action import get_action_input
+from release_notes_generator.utils.utils import normalize_version_tag
 
 logger = logging.getLogger(__name__)
 
@@ -119,14 +120,16 @@ def get_tag_name() -> str:
         """
         Get the tag name from the action inputs.
         """
-        return get_action_input(TAG_NAME) or ""
+        raw = get_action_input(TAG_NAME) or ""
+        return normalize_version_tag(raw)
 
     @staticmethod
     def get_from_tag_name() -> str:
         """
         Get the from-tag name from the action inputs.
         """
-        return get_action_input(FROM_TAG_NAME, default="")  # type: ignore[return-value] # string is returned as default
+        raw = get_action_input(FROM_TAG_NAME, default="")
+        return normalize_version_tag(raw)  # type: ignore[arg-type]
 
     @staticmethod
     def is_from_tag_name_defined() -> bool:
@@ -416,6 +419,7 @@ def validate_inputs() -> None:
 
         logger.debug("Repository: %s/%s", ActionInputs._owner, ActionInputs._repo_name)
         logger.debug("Tag name: %s", tag_name)
+        logger.debug("From tag name: %s", from_tag_name)
         logger.debug("Chapters: %s", chapters)
         logger.debug("Published at: %s", published_at)
         logger.debug("Skip release notes labels: %s", ActionInputs.get_skip_release_notes_labels())

release_notes_generator/utils/utils.py

@@ -19,6 +19,7 @@
 """
 
 import logging
+import re
 
 from typing import Optional
 
@@ -54,3 +55,46 @@ def get_change_url(
         changelog_url = f"https://github.com/{repo.full_name}/compare/{rls.tag_name}...{tag_name}"
 
     return changelog_url
+
+
+_SEMVER_SHORT_RE = re.compile(
+    r"""
+    ^\s*                # optional leading whitespace
+    v?                  # optional leading 'v'
+    (?P<major>\d+)      # major
+    \.                  # dot
+    (?P<minor>\d+)      # minor
+    (?:\.(?P<patch>\d+))?  # optional .patch
+    \s*$                # optional trailing whitespace
+""",
+    re.VERBOSE,
+)
+
+
+def normalize_version_tag(tag: str) -> str:
+    """
+    Normalize a tag to full 'vMAJOR.MINOR.PATCH' form.
+
+    Accepts:
+      - 'v1.2.3'  -> 'v1.2.3'
+      - 'v1.2'    -> 'v1.2.0'
+      - '1.2.3'   -> 'v1.2.3'
+      - '1.2'     -> 'v1.2.0'
+
+    Returns empty string if input is empty/whitespace.
+    Raises ValueError on malformed versions.
+    """
+    if not tag or tag.strip() == "":
+        return ""
+
+    m = _SEMVER_SHORT_RE.match(tag)
+    if not m:
+        raise ValueError(
+            f"Invalid version tag format: {tag!r}. " "Expected vMAJOR.MINOR[.PATCH], e.g. 'v0.2' or 'v0.2.0'."
+        )
+
+    major = int(m.group("major"))
+    minor = int(m.group("minor"))
+    patch = int(m.group("patch")) if m.group("patch") is not None else 0
+
+    return f"v{major}.{minor}.{patch}"

tests/test_action_inputs.py

@@ -108,11 +108,60 @@ def test_get_github_token(mocker):
     assert ActionInputs.get_github_token() == "fake-token"
 
 
-def test_get_tag_name(mocker):
+def test_get_tag_name_version_full(mocker):
     mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="v1.0.0")
     assert ActionInputs.get_tag_name() == "v1.0.0"
 
 
+def test_get_tag_name_version_shorted_with_v(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="v1.2")
+    assert ActionInputs.get_tag_name() == "v1.2.0"
+
+
+def test_get_tag_name_version_shorted_no_v(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="1.2")
+    assert ActionInputs.get_tag_name() == "v1.2.0"
+
+
+def test_get_tag_name_empty(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="")
+    assert ActionInputs.get_tag_name() == ""
+
+
+def test_get_tag_name_invalid_format(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="v1.2.beta")
+    with pytest.raises(ValueError) as excinfo:
+        ActionInputs.get_tag_name()
+    assert "Invalid version tag format: 'v1.2.beta'. Expected vMAJOR.MINOR[.PATCH], e.g. 'v0.2' or 'v0.2.0'." in str(excinfo.value)
+
+
+def test_get_tag_from_name_version_full(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="v1.0.0")
+    assert ActionInputs.get_from_tag_name() == "v1.0.0"
+
+
+def test_get_from_tag_name_version_shorted_with_v(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="v1.2")
+    assert ActionInputs.get_from_tag_name() == "v1.2.0"
+
+
+def test_get_from_tag_name_version_shorted_no_v(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="1.2")
+    assert ActionInputs.get_from_tag_name() == "v1.2.0"
+
+
+def test_get_from_tag_name_empty(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="")
+    assert ActionInputs.get_from_tag_name() == ""
+
+
+def test_get_from_tag_name_invalid_format(mocker):
+    mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="v1.2.beta")
+    with pytest.raises(ValueError) as excinfo:
+        ActionInputs.get_from_tag_name()
+    assert "Invalid version tag format: 'v1.2.beta'. Expected vMAJOR.MINOR[.PATCH], e.g. 'v0.2' or 'v0.2.0'." in str(excinfo.value)
+
+
 def test_get_chapters_success(mocker):
     mocker.patch("release_notes_generator.action_inputs.get_action_input", return_value="[{\"title\": \"Title\", \"label\": \"Label\"}]")
     assert ActionInputs.get_chapters() == [{"title": "Title", "label": "Label"}]