Make sortable prerelease fields

Instead of `1.2.3-n003.habc` produce `1.2.3-0git.3.habc`

- allow fully numerical fields (Leading 0s are only forbidden for numerical fields, not alphanumeric)
- prefix with `0git.` to sort before 'alpha'

Author: minrk

README.md

@@ -25,22 +25,25 @@ Chartpress will infer chart versions and image tags using a few key pieces of
 information.
 
 1. `tag`: If not directly set by `--tag`, it will be inferred from most recent
-   commit that is tagged in the _current branch_, or be set to 0.0.1 if no
-   commit is tagged.
+   commit that is tagged in the _current branch_
+   (as determined by `git describe`)
+   or be set to 0.0.1 if no commit is tagged.
    1. If the `tag` has a leading `v` but is otherwise a valid
-      [SemVer2](https://semver.org) version, it will be stripped from Chart.yaml
+      [SemVer2](https://semver.org) version, the `v` will be stripped from Chart.yaml
       before its set as Helm 3 requires Helm chart versions to be SemVer2
       compliant.
 1. The latest commit modifying content in a _relevant path_ since `tag`.
-   1. `n`: The latest commit's distance to the tagged commit, described as 3 or
-      more numbers, prefixed with n.
+   1. `n`: The number of commits since the tagged commit, as an integer.
    1. `h`: The latest commit's abbreviated hash. which is often 7-8 characters,
-      prefixed with h.
-1. If `tag` (like `0.10.0` or `0.10.0-beta.1`) contains a `-`, a `tag.n.h`
-   format will be used instead of a `tag-n.h` format to be SemVer 2 compliant.
+      prefixed with `h`.
+1. If `tag` (like `0.10.0` or `0.10.0-beta.1`) contains `-`,
+   indicating that it is a prerelease,
+   the chartpress suffix will be added to the prerelease fields,
+   e.g. `0.10.0-beta.1.0git.5.habc123`
+   format will be used instead of a `tag-0git.n.h` format to be SemVer 2 compliant.
 1. If `--long` is specified or not. If `--long` is specified, tagged commits
-   will be written out with the `n.h` part appended to it, looking something
-   like `n000.gabcd123`
+   will always be written out with the `n.h` part appended to it, looking something
+   like `1.0.0-0git.0.habcd123`
 
 ### Examples chart versions and image tags
 
@@ -49,13 +52,13 @@ order that could come from using chartpress.
 
 ```
 0.8.0
-0.8.0-n004.hasdf123
-0.8.0-n010.hsdfg234
+0.8.0-0git.4.hasdf123
+0.8.0-0git.10.hsdfg234
 0.9.0-beta.1
-0.9.0-beta.1.n001.hdfgh345
-0.9.0-beta.1.n005.hfghj456
+0.9.0-beta.1.0git.1.hdfgh345
+0.9.0-beta.1.0git.5.hfghj456
 0.9.0-beta.2
-0.9.0-beta.2.n001.hghjk567
+0.9.0-beta.2.0git.1.hghjk567
 0.9.0-beta.3
 0.9.0
 ```

chartpress.py

@@ -29,6 +29,9 @@
 # name of possible repository keys used in image value
 IMAGE_REPOSITORY_KEYS = {"name", "repository"}
 
+# prefix in prerelease tag for git commit count
+PRERELEASE_PREFIX = "0git."
+
 # Container builders
 class Builder(Enum):
     DOCKER_BUILD = "docker-build"
@@ -481,24 +484,28 @@ def _get_identifier_from_parts(tag, n_commits, commit, long):
     This function should provide valid Helm chart versions, which means they
     need to be valid SemVer 2 version strings. It also needs to return valid
     image tags, which means they need to not contain `+` signs either. We prefix
-    with n and h to ensure we don't get a numerical hash starting with 0 because
+    with h to ensure we don't get a numerical hash starting with 0 because
     those are invalid SemVer 2 versions.
 
+    We lead with '0git.' to ensure our suffixes sort as older than any explicit tags,
+    such as `0.1.2-alpha.1 > 0.1.2-alpha.0git.5.habc > 0.1.2-0git.3.h123`
+
     Example:
         tag="0.1.2", n_commits="5", commit="asdf1234", long=True,
-        should return "0.1.2-n005.hasdf1234".
+        should return "0.1.2-0git.5.hasdf1234".
     """
     n_commits = int(n_commits)
 
     if n_commits > 0 or long:
         if "-" in tag:
-            # append a pre-release tag, with a . separator
-            # 0.1.2-alpha.1 -> 0.1.2-alpha.1.n.h
-            return f"{tag}.n{n_commits:03d}.h{commit}"
+            # add a field to an existing prerelease tag
+            # 0.1.2-alpha.1 -> 0.1.2-{PRERELEASE_PREFIX}5.hsha
+            sep = "."
         else:
-            # append a release tag, with a - separator
-            # 0.1.2 -> 0.1.2-n.h
-            return f"{tag}-n{n_commits:03d}.h{commit}"
+            # create prerelease tag
+            # 0.1.2-alpha.1 -> 0.1.2-{PRERELEASE_PREFIX}5.hsha
+            sep = "-"
+        return f"{tag}{sep}{PRERELEASE_PREFIX}{n_commits}.h{commit}"
     else:
         return f"{tag}"
 
@@ -542,11 +549,11 @@ def build_images(
 
         Example 1:
         - long=False: 0.9.0
-        - long=True:  0.9.0-n000.hasdf1234
+        - long=True:  0.9.0-0git.0.hasdf1234
 
         Example 2:
-        - long=False: 0.9.0-n004.hsdfg2345
-        - long=True:  0.9.0-n004.hsdfg2345
+        - long=False: 0.9.0-0git.4.hsdfg2345
+        - long=True:  0.9.0-0git.4.hsdfg2345
 
     builder (str):
         The container build engine.
@@ -714,11 +721,11 @@ def build_chart(
 
     Example versions constructed:
         - 0.9.0-alpha.1
-        - 0.9.0-alpha.1.n000.hasdf1234 (--long)
-        - 0.9.0-alpha.1.n005.hsdfg2345
-        - 0.9.0-alpha.1.n005.hsdfg2345 (--long)
+        - 0.9.0-alpha.1.0git.0.hasdf1234 (--long)
+        - 0.9.0-alpha.1.0git.5.hsdfg2345
+        - 0.9.0-alpha.1.0git.5.hsdfg2345 (--long)
         - 0.9.0
-        - 0.9.0-n002.hdfgh3456
+        - 0.9.0-0git.2.hdfgh3456
     """
     # read Chart.yaml
     chart_file = os.path.join(name, "Chart.yaml")

tests/test_chartpress.py

@@ -25,7 +25,7 @@ def test_list_images(git_repo):
     assert len(images) == 1
     # split hash_suffix which will be different every run
     pre_hash, hash_suffix = images[0].rsplit(".", 1)
-    assert pre_hash == "testchart/testimage:0.0.1-n001"
+    assert pre_hash == "testchart/testimage:0.0.1-0git.1"
 
     p = run(
         ["git", "status", "--porcelain"],

tests/test_commands.py

@@ -5,6 +5,7 @@
 from ruamel.yaml import YAML
 
 import chartpress
+from chartpress import PRERELEASE_PREFIX
 
 
 @pytest.mark.parametrize("with_args", [False, True])
@@ -78,7 +79,7 @@ def test_build_images(git_repo, mock_check_call, push, tag):
     if tag:
         expected_tag = tag
     else:
-        expected_tag = f"0.0.1-n001.h{sha[:7]}"
+        expected_tag = f"0.0.1-{PRERELEASE_PREFIX}1.h{sha[:7]}"
 
     expected_build1 = [
         "docker",
@@ -168,7 +169,7 @@ def test_buildx_images(
     if tag:
         expected_tag = tag
     else:
-        expected_tag = f"0.0.1-n001.h{sha[:7]}"
+        expected_tag = f"0.0.1-{PRERELEASE_PREFIX}1.h{sha[:7]}"
 
     expected_build1 = [
         "docker",
@@ -272,7 +273,7 @@ def test_build_chart(git_repo, mock_check_call, version):
     if version:
         expected_version = version
     else:
-        expected_version = f"0.0.1-n001.h{sha[:7]}"
+        expected_version = f"0.0.1-{PRERELEASE_PREFIX}1.h{sha[:7]}"
 
     assert rv == expected_version
 

tests/test_helpers.py

@@ -2,58 +2,34 @@
 from ruamel.yaml import YAML
 
 from chartpress import _check_call
+from chartpress import _fix_chart_version
 from chartpress import _get_git_remote_url
 from chartpress import _get_identifier_from_parts
 from chartpress import _get_image_build_args
 from chartpress import _get_latest_commit_tagged_or_modifying_paths
 from chartpress import _image_needs_pushing
-from chartpress import Builder
 from chartpress import GITHUB_ACTOR_KEY
 from chartpress import GITHUB_TOKEN_KEY
+from chartpress import yaml
 
-# use safe roundtrip yaml loader
-yaml = YAML(typ="rt")
-yaml.preserve_quotes = True  ## avoid mangling of quotes
-yaml.indent(mapping=2, offset=2, sequence=4)
 
-
-def test__get_identifier_from_parts():
-    assert (
-        _get_identifier_from_parts(
-            tag="0.1.2", n_commits="0", commit="asdf123", long=True
-        )
-        == "0.1.2-n000.hasdf123"
-    )
-    assert (
-        _get_identifier_from_parts(
-            tag="0.1.2", n_commits="0", commit="asdf123", long=False
-        )
-        == "0.1.2"
-    )
-    assert (
-        _get_identifier_from_parts(
-            tag="0.1.2", n_commits="5", commit="asdf123", long=False
-        )
-        == "0.1.2-n005.hasdf123"
-    )
-    assert (
-        _get_identifier_from_parts(
-            tag="0.1.2-alpha.1", n_commits="0", commit="asdf1234", long=True
-        )
-        == "0.1.2-alpha.1.n000.hasdf1234"
-    )
-    assert (
-        _get_identifier_from_parts(
-            tag="0.1.2-alpha.1", n_commits="0", commit="asdf1234", long=False
-        )
-        == "0.1.2-alpha.1"
-    )
-    assert (
-        _get_identifier_from_parts(
-            tag="0.1.2-alpha.1", n_commits="5", commit="asdf1234", long=False
-        )
-        == "0.1.2-alpha.1.n005.hasdf1234"
+@pytest.mark.parametrize(
+    "tag, n_commits, commit, long, expected",
+    [
+        ("0.1.2", "0", "asdf123", True, "0.1.2-0git.0.hasdf123"),
+        ("0.1.2", "0", "asdf123", False, "0.1.2"),
+        ("0.1.2", "5", "asdf123", False, "0.1.2-0git.5.hasdf123"),
+        ("0.1.2-alpha.1", "0", "asdf1234", True, "0.1.2-alpha.1.0git.0.hasdf1234"),
+        ("0.1.2-alpha.1", "0", "asdf1234", False, "0.1.2-alpha.1"),
+        ("0.1.2-alpha.1", "5", "asdf1234", False, "0.1.2-alpha.1.0git.5.hasdf1234"),
+    ],
+)
+def test_get_identifier_from_parts(tag, n_commits, commit, long, expected):
+    tag = _get_identifier_from_parts(
+        tag=tag, n_commits=n_commits, commit=commit, long=long
     )
+    assert tag == expected
+    _fix_chart_version(tag, strict=True)
 
 
 def test__get_git_remote_url(monkeypatch):