Embed the project version in the name of binaries (#851)

Author: ofek

backend/src/hatchling/builders/app.py

@@ -153,13 +153,21 @@ def build_bootstrap(self, directory: str, **build_data: Any) -> str:
 
                     self.cargo_build(install_command, cwd=context_dir, env=env)
 
-                    exe_stem = f'{script}-{build_target}' if build_target else script
+                    exe_stem = (
+                        f'{script}-{self.metadata.version}-{build_target}'
+                        if build_target
+                        else f'{script}-{self.metadata.version}'
+                    )
                     exe_path = os.path.join(app_dir, f'{exe_stem}.exe' if on_windows else exe_stem)
                     shutil.move(temp_exe_path, exe_path)
             else:
                 self.cargo_build(install_command, cwd=context_dir, env=base_env)
 
-                exe_stem = f'{self.metadata.name}-{build_target}' if build_target else self.metadata.name
+                exe_stem = (
+                    f'{self.metadata.name}-{self.metadata.version}-{build_target}'
+                    if build_target
+                    else f'{self.metadata.name}-{self.metadata.version}'
+                )
                 exe_path = os.path.join(app_dir, f'{exe_stem}.exe' if on_windows else exe_stem)
                 shutil.move(temp_exe_path, exe_path)
 

docs/history/hatchling.md

@@ -8,6 +8,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## Unreleased
 
+***Added:***
+
+- The `app` build target now embeds the project version in the name of binaries
+
 ## [1.16.1](https://github.com/pypa/hatch/releases/tag/hatchling-v1.16.1) - 2023-05-11 ## {: #hatchling-v1.16.1 }
 
 ***Fixed:***

tests/backend/builders/test_app.py

@@ -274,7 +274,7 @@ def test_default(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('my-app.exe' if sys.platform == 'win32' else 'my-app')).is_file()
+        assert (build_path / 'app' / ('my-app-0.1.0.exe' if sys.platform == 'win32' else 'my-app-0.1.0')).is_file()
 
     def test_default_build_target(self, hatch, helpers, temp_dir, mocker):
         subprocess_run = mocker.patch('subprocess.run', side_effect=cargo_install)
@@ -316,7 +316,9 @@ def test_default_build_target(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('my-app-target.exe' if sys.platform == 'win32' else 'my-app-target')).is_file()
+        assert (
+            build_path / 'app' / ('my-app-0.1.0-target.exe' if sys.platform == 'win32' else 'my-app-0.1.0-target')
+        ).is_file()
 
     def test_scripts(self, hatch, helpers, temp_dir, mocker):
         subprocess_run = mocker.patch('subprocess.run', side_effect=cargo_install)
@@ -360,7 +362,7 @@ def test_scripts(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('foo.exe' if sys.platform == 'win32' else 'foo')).is_file()
+        assert (build_path / 'app' / ('foo-0.1.0.exe' if sys.platform == 'win32' else 'foo-0.1.0')).is_file()
 
     def test_scripts_build_target(self, hatch, helpers, temp_dir, mocker):
         subprocess_run = mocker.patch('subprocess.run', side_effect=cargo_install)
@@ -404,7 +406,9 @@ def test_scripts_build_target(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('foo-target.exe' if sys.platform == 'win32' else 'foo-target')).is_file()
+        assert (
+            build_path / 'app' / ('foo-0.1.0-target.exe' if sys.platform == 'win32' else 'foo-0.1.0-target')
+        ).is_file()
 
     def test_custom_cargo(self, hatch, helpers, temp_dir, mocker):
         subprocess_run = mocker.patch('subprocess.run', side_effect=cargo_install)
@@ -446,7 +450,7 @@ def test_custom_cargo(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('my-app.exe' if sys.platform == 'win32' else 'my-app')).is_file()
+        assert (build_path / 'app' / ('my-app-0.1.0.exe' if sys.platform == 'win32' else 'my-app-0.1.0')).is_file()
 
     def test_no_cargo(self, hatch, helpers, temp_dir, mocker):
         mocker.patch('shutil.which', return_value=None)
@@ -514,7 +518,7 @@ def test_python_version(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('my-app.exe' if sys.platform == 'win32' else 'my-app')).is_file()
+        assert (build_path / 'app' / ('my-app-0.1.0.exe' if sys.platform == 'win32' else 'my-app-0.1.0')).is_file()
 
     def test_pyapp_version(self, hatch, helpers, temp_dir, mocker):
         subprocess_run = mocker.patch('subprocess.run', side_effect=cargo_install)
@@ -556,7 +560,7 @@ def test_pyapp_version(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('my-app.exe' if sys.platform == 'win32' else 'my-app')).is_file()
+        assert (build_path / 'app' / ('my-app-0.1.0.exe' if sys.platform == 'win32' else 'my-app-0.1.0')).is_file()
 
     def test_verbosity(self, hatch, helpers, temp_dir, mocker):
         subprocess_run = mocker.patch('subprocess.run', side_effect=cargo_install)
@@ -596,7 +600,7 @@ def test_verbosity(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('my-app.exe' if sys.platform == 'win32' else 'my-app')).is_file()
+        assert (build_path / 'app' / ('my-app-0.1.0.exe' if sys.platform == 'win32' else 'my-app-0.1.0')).is_file()
 
     def test_local_build_with_build_target(self, hatch, helpers, temp_dir, mocker):
         subprocess_run = mocker.patch('subprocess.run', side_effect=cargo_install)
@@ -638,7 +642,9 @@ def test_local_build_with_build_target(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('my-app-target.exe' if sys.platform == 'win32' else 'my-app-target')).is_file()
+        assert (
+            build_path / 'app' / ('my-app-0.1.0-target.exe' if sys.platform == 'win32' else 'my-app-0.1.0-target')
+        ).is_file()
 
     def test_local_build_no_build_target(self, hatch, helpers, temp_dir, mocker):
         subprocess_run = mocker.patch('subprocess.run', side_effect=cargo_install)
@@ -680,4 +686,4 @@ def test_local_build_no_build_target(self, hatch, helpers, temp_dir, mocker):
         build_artifacts = list(build_path.iterdir())
         assert len(build_artifacts) == 1
         assert expected_artifact == str(build_artifacts[0])
-        assert (build_path / 'app' / ('my-app.exe' if sys.platform == 'win32' else 'my-app')).is_file()
+        assert (build_path / 'app' / ('my-app-0.1.0.exe' if sys.platform == 'win32' else 'my-app-0.1.0')).is_file()