feat: dynamic version from VCS and release notes auto-generation (#164)

Signed-off-by: Frost Ming <me@frostming.com>

Author: frostming

.github/workflows/on-release-main.yml

@@ -6,32 +6,25 @@ on:
 
 jobs:
 
-  set-version:
-    runs-on: ubuntu-24.04
+  release-note:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@v6
-
-      - name: Export tag
-        id: vars
-        run: echo tag=${GITHUB_REF#refs/*/} >> $GITHUB_OUTPUT
-        if: ${{ github.event_name == 'release' }}
-
-      - name: Update project version
-        run: |
-          sed -i "s/^version = \".*\"/version = \"$RELEASE_VERSION\"/" pyproject.toml
-        env:
-          RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
-        if: ${{ github.event_name == 'release' }}
+      - name: Check out
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
 
-      - name: Upload updated pyproject.toml
-        uses: actions/upload-artifact@v6
+      - uses: actions/setup-node@v6
         with:
-          name: pyproject-toml
-          path: pyproject.toml
+          node-version: lts/*
+
+      - run: npx changelogithub
+        continue-on-error: true
 
   publish:
     runs-on: ubuntu-latest
-    needs: [set-version]
     steps:
       - name: Check out
         uses: actions/checkout@v6

.gitignore

@@ -145,3 +145,4 @@ reference/
 
 # Local legacy backups created during framework migrations
 backup/
+_version.py

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "bub"
-version = "0.3.5"
+dynamic = ["version"]
 description = "A common shape for agents that live alongside people."
 authors = [
     { name = "Chojan Shang", email = "psiace@apache.org" },
@@ -64,9 +64,15 @@ dev = [
 ]
 
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/bub/_version.py"
+
 [tool.hatch.build.targets.sdist]
 only-include = ["src/bub", "src/skills", "tests"]
 

src/bub/__init__.py

@@ -1,8 +1,19 @@
 """Bub framework package."""
 
+from importlib import import_module
+from importlib.metadata import PackageNotFoundError
+from importlib.metadata import version as metadata_version
+
 from bub.framework import BubFramework
 from bub.hookspecs import hookimpl
 from bub.tools import tool
 
 __all__ = ["BubFramework", "hookimpl", "tool"]
-__version__ = "0.3.5"
+
+try:
+    __version__ = import_module("bub._version").version
+except ModuleNotFoundError:
+    try:
+        __version__ = metadata_version("bub")
+    except PackageNotFoundError:
+        __version__ = "0.0.0"