Develop (#9)

rough outline should be ready. Fixes #8, #2

Author: fleetingbytes

CHANGELOG.md

@@ -2,6 +2,19 @@
 
 <!-- towncrier release notes start -->
 
+## [0.0.4](https://github.com/Nagidal/hatch-semver/tree/0.0.4) - 2022-11-10
+
+
+### Development Details
+
+- Plugin structure is ready, should know how to bump major, minor, patch [#2](https://github.com/Nagidal/hatch-semver/issues/2)
+
+
+### Documentation
+
+- Better readme, but not final [#8](https://github.com/Nagidal/hatch-semver/issues/8)
+
+
 ## [0.0.3](https://github.com/Nagidal/hatch-semver/tree/0.0.3) - 2022-11-10
 
 

README.md

@@ -3,6 +3,30 @@
 A plugin for [hatch][hatch] to support [semantic versioning][semver].
 
 
+## Usage
+
+Introduce *hatch-semver* as a build-dependency to your project (in `pyproject.toml`):
+
+```toml
+[build-system]
+requires = [
+    "hatchling>=1.8.0",
+    "hatch-semver",
+]
+build-backend = "hatchling.build"
+```
+
+Further down in `pyproject.toml`, where you specify your project's version, set version scheme
+to `semver`:
+```toml
+[tool.hatch.version]
+path = "src/<your_project>/__about__.py"
+scheme = "semver"
+```
+
+You can then use hatch's usual [versioning commands][hatch_versioning] to bump your project's
+version in a semver-compliant way.
 
 [hatch]: hatch.pypa.io/
 [semver]: https://semver.org/
+[hatch_versioning]: https://hatch.pypa.io/latest/version/#updating

pyproject.toml

@@ -116,7 +116,7 @@ exclude_lines = [
     line-length = 102
 
 [tool.towncrier]
-name = "hatch_semver"
+name = "hatch-semver"
 package = "hatch_semver"
 package_dir = "src"
 directory = "changelog.d"

src/hatch_semver/__about__.py

@@ -8,5 +8,5 @@
 __maintainer__ = __author__
 __maintainer_email__ = __author_email__
 __release_date__ = date(year=2022, month=11, day=10)
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 

src/hatch_semver/semver_scheme.py

@@ -10,7 +10,37 @@ class SemverScheme(VersionSchemeInterface):
     - https://semver.org/
     - https://hatch.pypa.io/latest/plugins/version-scheme/reference/
     """
+
     PLUGIN_NAME = "semver"
 
     def update(self, desired_version, original_version, version_data) -> str:
-        return str("test_version")
+        from semver import VersionInfo
+
+        original = VersionInfo(original_version)
+        parts = desired_version.replace("micro", "patch").replace("fix", "patch").split(",")
+
+        for part in parts:
+            next_version = getattr(original, "bump_" + part)()
+            original = next_version
+            if part == "minor":
+                next_version = original.bump_minor()
+                original = next_version
+            elif part in ("post", "rev", "r"):
+                raise ValeError(f"Semver has no concept of a post-release. Use 'build' instead")
+            elif version == "dev":
+                raise ValeError(f"Semver has no concept of a dev-release. Use 'build' instead")
+            else:
+                if len(parts) > 1:
+                    raise ValueError(
+                        "Cannot specify multiple update operations with an explicit version"
+                    )
+
+                next_version = VersionInfo.parse(part)
+                if self.config.get("validate-bump", True) and next_version <= original:
+                    raise ValueError(
+                        f"Version `{part}` is not higher than the original version `{original_version}`"
+                    )
+                else:
+                    return str(next_version)
+
+        return str(original)