Merge pull request #106 from bwhmather/freeze-version

Automatically freeze version during release

.github/workflows/release.yaml

@@ -15,11 +15,14 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v3
       with:
-        python-version: 3.7
+        python-version: 3.11
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install build
+    - name: Freeze version
+      run: |
+        python scripts/freeze_version.py "$GITHUB_REF_NAME"
     - name: Build package
       run: python -m build
     - name: Publish distribution to PyPI

.gitignore

@@ -1,3 +1,4 @@
 __pycache__/
 *.egg-info/
 .tox
+src/ssort/_version.py

scripts/freeze_version.py

@@ -0,0 +1,40 @@
+"""
+Reads a version string from stdin and writes a python script which exports it
+to stdout.
+"""
+
+import argparse
+import pathlib
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Hard codes the version number reported by ssort"
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=pathlib.Path,
+        default=pathlib.Path("src/ssort/_version.py"),
+        help="Where to write the frozen version number",
+    )
+    parser.add_argument(
+        "version",
+        type=str,
+        help="The new version number to write",
+    )
+
+    args = parser.parse_args()
+
+    output = f"""\"\"\"
+Generated by `scripts/freeze_version.py`.  Do not edit directly.
+\"\"\"
+
+VERSION = {args.version!r}
+"""
+
+    args.output.write_text(output)
+
+
+if __name__ == "__main__":
+    main()

src/ssort/__init__.py

@@ -17,5 +17,9 @@
 assert UnknownEncodingError is not None
 assert WildcardImportError is not None
 
-__version__ = "0.12.0"
+try:
+    from ssort._version import VERSION as __version__  # type: ignore
+except ImportError:
+    __version__ = "0.0.1+dev"
+
 __all__ = ["ssort"]