[CI/CD] Store version number in alpa._version__ (#626)

.github/workflows/release_alpa.yml

@@ -61,34 +61,3 @@ jobs:
           echo "Publish to PyPI"
           ls -ltr dist/
           python -m twine upload --verbose dist/*
-
-  update-version:
-    runs-on: [ubuntu-latest]
-    needs: [release-alpa]
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Bump VERSION and commit
-        run: |
-          git config --local user.email "[email protected]"
-          git config --local user.name "GitHub Action"
-          git checkout -b actions/version-bump
-          cat VERSION | awk -F. -v OFS=. 'NF==1{print ++$NF}; NF>1{$NF=sprintf("%0*d", length($NF), ($NF+1)); print}' > VERSION.tmp && mv VERSION.tmp VERSION
-          git add VERSION
-          git commit -m "Bump candidate version [skip ci]"
-
-      - name: Push branch
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.PAT_TOKEN }}
-          branch: actions/version-bump
-          force: true
-
-      - name: Create version-bump PR
-        uses: repo-sync/pull-request@v2
-        with:
-          github_token: ${{ secrets.PAT_TOKEN }}
-          source_branch: "actions/version-bump"
-          destination_branch: "main"
-          pr_title: "Bumping VERSION file due to recent release"
-          pr_body: "*Automated PR*: This should update the candidate version. Please delete source branch upon merge"

alpa/__init__.py

@@ -26,6 +26,7 @@
 from alpa.shard_parallel.auto_sharding import AutoShardingOption
 from alpa.serialization import save_checkpoint, restore_checkpoint
 from alpa.timer import timers
+from alpa.version import __version__
 
 from . import api
 from . import collective

alpa/version.py

@@ -0,0 +1,3 @@
+"""Version information."""
+
+__version__ = "1.0.0.dev0"

docker/scripts/build_alpa.sh

@@ -50,7 +50,7 @@ git fetch origin +${ALPA_BRANCH}
 git checkout -qf FETCH_HEAD
 
 # install jaxlib and jax
-export VERSION=$(bash GENVER --pep440)
+python3 update_version.py --git-describe
 python3 setup.py bdist_wheel
 
 if ! python3 -m auditwheel show dist/alpa-*.whl  | egrep 'platform tag: "(manylinux2014_x86_64|manylinux_2_17_x86_64)"' > /dev/null; then

docs/conf.py

@@ -16,11 +16,22 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Alpa'
-#copyright = '2022, <Author>'
-#author = '<Author>'
+author = 'Alpa Developers'
+copyright = f'2022, {author}'
 
-# The full version, including alpha/beta/rc tags
-release = '0.1.4'
+
+def git_describe_version():
+    """Get git describe version."""
+    ver_py = os.path.join("..", "update_version.py")
+    libver = {"__file__": ver_py}
+    exec(compile(open(ver_py, "rb").read(), ver_py, "exec"), libver, libver)
+    gd_version, _ = libver["git_describe_version"]()
+    return gd_version
+
+
+import alpa
+version = git_describe_version()
+release = version
 
 
 # -- General configuration ---------------------------------------------------

setup.py

@@ -1,12 +1,14 @@
 import glob
 import os
+import re
 import shutil
 import subprocess
 import sys
 
 from setuptools import setup, find_packages
 
 IS_WINDOWS = sys.platform == "win32"
+ROOT_DIR = os.path.dirname(__file__)
 
 
 def get_cuda_version(cuda_home):
@@ -98,6 +100,16 @@ def get_cuda_version_str(no_dot=False):
 ]
 
 
+def get_alpa_version():
+    with open(os.path.join(ROOT_DIR, "alpa", "version.py")) as fp:
+        version_match = re.search(
+            r"^__version__ = ['\"]([^'\"]*)['\"]", fp.read(), re.M
+        )
+        if version_match:
+            return version_match.group(1)
+    raise RuntimeError("Unable to find version string.")
+
+
 def build():
     """Build the custom pipeline marker API."""
     # Check cuda version
@@ -169,13 +181,13 @@ def finalize_options(self):
             if self.distribution.has_ext_modules():
                 self.install_lib = self.install_platlib
 
-    with open(os.path.join("README.md"), encoding="utf-8") as f:
+    with open("README.md", encoding="utf-8") as f:
         long_description = f.read()
 
     setup(
         name="alpa",
-        version=os.environ.get("VERSION"),
-        author="Alpa team",
+        version=get_alpa_version(),
+        author="Alpa Developers",
         author_email="",
         description=
         "Alpa automatically parallelizes large tensor computation graphs and "