Determine version dynamically

Author: FichteFoll

.github/workflows/release.yml

@@ -1,7 +1,9 @@
 name: Publish Release
 
 on:
-  workflow_dispatch:
+  push:
+    tags:
+      - v*
 
 jobs:
   release:
@@ -23,4 +25,4 @@ jobs:
       - name: Create release & upload wheel
         run: |
           version=$(uv version --short)
-          gh release create --generate-notes --latest -t "v${version}" "v${version}" dist/*.whl
+          gh release create --generate-notes --latest -t "$GITHUB_REF_NAME" "$GITHUB_REF_NAME" dist/*.whl

.gitignore

@@ -4,6 +4,7 @@ __pycache__
 
 # build artifacts
 dist/
+_version.py
 
 # docs build artifacts
 /docs/html/

README.md

@@ -37,6 +37,9 @@ Highlights include:
 
 ## Releasing a new version
 
-1. Bump version in `pyproject.toml` & commit it.
-3. Push to origin.
-4. On GitHub > Actions, run "release" action against `master`.
+1. Create a tag in the format `v<major>.<minor>.<patch>`
+2. Push the tag to origin.
+
+A github action should be created that builds a WHEEL file,
+creates a release for this tag
+and attaches the WHEEL file as an artifact.

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sublime_lib"
-version = "1.6.0"
+dynamic = ["version"]
 description = "Utility library for frequently used functionality in Sublime Text"
 readme = "README.md"
 license = {file = "LICENSE"}
@@ -33,6 +33,13 @@ exclude = [
     "*.lock",
 ]
 
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/sublime_lib/_version.py"
+tag-pattern = "v{version}"
+
 [tool.coverage.run]
 omit = [
     "*/tests/*",