Add SPY_BRANCH and SPY_COMMIT environment variables to standalone runtime environments.

- Patch spyder-menu.json in build_conda_pkgs.py instead of build.sh and bld.bat, i.e. patching the feedstock rather than having the feedstock patch the build. This is more efficient since these variables are not available to conda-build.
- Move the build.sh patch to build_conda_pkgs.py from a separate script file. Note that handling the application icon for Windows as this will never be executed.

Author: mrclary

installers-conda/build_conda_pkgs.py

@@ -66,6 +66,8 @@ def __init__(self, data={}, debug=False, shallow=False):
         self._get_source(shallow=shallow)
         self._get_version()
 
+        self._patch_source()
+
         self.data = {'version': self.version}
         self.data.update(data)
 
@@ -77,7 +79,7 @@ def _get_source(self, shallow=False):
 
         if self.source == HERE.parent:
             self._bld_src = self.source
-            repo = Repo(self.source)
+            self.repo = Repo(self.source)
         else:
             # Determine source and commit
             if self.source is not None:
@@ -97,10 +99,8 @@ def _get_source(self, shallow=False):
                     f"Cloning source shallow from tag {self.shallow_ver}...")
             else:
                 self.logger.info("Cloning source...")
-            repo = Repo.clone_from(remote, **kwargs)
-            repo.git.checkout(commit)
-
-        self._patch_source(repo)
+            self.repo = Repo.clone_from(remote, **kwargs)
+            self.repo.git.checkout(commit)
 
         # Clone feedstock
         self.logger.info("Cloning feedstock...")
@@ -117,7 +117,7 @@ def _get_version(self):
         """Get source version using setuptools_scm"""
         self.version = get_version(self._bld_src).split('+')[0]
 
-    def _patch_source(self, repo):
+    def _patch_source(self):
         pass
 
     def _patch_meta(self, meta):
@@ -127,7 +127,12 @@ def _patch_build_script(self):
         pass
 
     def patch_recipe(self):
-        """Patch conda build recipe"""
+        """
+        Patch conda build recipe
+
+        1. Patch meta.yaml
+        2. Patch build script
+        """
         if self._recipe_patched:
             return
 
@@ -161,9 +166,8 @@ def build(self):
         Build the conda package.
 
         1. Patch the recipe
-        2. Patch the build script
-        3. Build the package
-        4. Remove cloned repositories
+        2. Build the package
+        3. Remove cloned repositories
         """
         t0 = time()
         try:
@@ -193,17 +197,27 @@ class SpyderCondaPkg(BuildCondaPkg):
     feedstock = "https://github.com/conda-forge/spyder-feedstock"
     shallow_ver = "v5.3.2"
 
-    def _patch_source(self, repo):
+    def _patch_source(self):
         self.logger.info("Creating Spyder source patch...")
 
-        patch = repo.git.format_patch(
+        patch = self.repo.git.format_patch(
             "..origin/installers-conda-patch", "--stdout", "-U3"
         )
         # newline keyword is not added to pathlib until Python>=3.10,
         # so we must use open to ensure LF on Windows
         with open(SPYPATCHFILE, 'w', newline='\n') as f:
             f.write(patch)
 
+        self.logger.info("Creating Spyder menu file...")
+        _menufile = RESOURCES / "spyder-menu.json"
+        menufile = DIST / "spyder-menu.json"
+        commit, branch = self.repo.head.commit.name_rev.split()
+        text = _menufile.read_text()
+        text = text.replace("__PKG_VERSION__", self.version)
+        text = text.replace("__SPY_BRANCH__", branch)
+        text = text.replace("__SPY_COMMIT__", commit[:8])
+        menufile.write_text(text)
+
     def _patch_meta(self, meta):
         # Add source code patch
         search_patches = re.compile(
@@ -266,18 +280,30 @@ def _patch_build_script(self):
 
         if os.name == 'posix':
             file = self._fdstk_path / "recipe" / "build.sh"
-            build_patch = RESOURCES / "build-patch.sh"
             text = file.read_text()
-            text += build_patch.read_text()
+            text += dedent(
+                """
+                # Create the Menu directory
+                mkdir -p "${PREFIX}/Menu"
+
+                # Copy menu.json template
+                cp "${SRC_DIR}/installers-conda/dist/spyder-menu.json" "${PREFIX}/Menu/spyder-menu.json"
+
+                # Copy application icons
+                if [[ $OSTYPE == "darwin"* ]]; then
+                    cp "${SRC_DIR}/img_src/spyder.icns" "${PREFIX}/Menu/spyder.icns"
+                else
+                    cp "${SRC_DIR}/branding/logo/logomark/spyder-logomark-background.png" "${PREFIX}/Menu/spyder.png"
+                fi
+                """
+            )
+
         if os.name == 'nt':
             file = self._fdstk_path / "recipe" / "bld.bat"
             text = file.read_text()
             text = text.replace(
                 r"copy %RECIPE_DIR%\menu-windows.json %MENU_DIR%\spyder_shortcut.json",
-                r"""powershell -Command"""
-                r""" "(gc %SRC_DIR%\installers-conda\resources\spyder-menu.json)"""
-                r""" -replace '__PKG_VERSION__', '%PKG_VERSION%' | """
-                r"""Out-File -encoding ASCII %MENU_DIR%\spyder-menu.json" """
+                r"copy %SRC_DIR%\installers-conda\dist\spyder-menu.json %MENU_DIR%\spyder-menu.json"
             )
         file.rename(file.parent / ("_" + file.name))  # keep copy of original
         file.write_text(text)

installers-conda/resources/build-patch.sh

@@ -12,13 +12,15 @@
             "terminal": false,
             "platforms": {
                 "win": {
-                    "desktop": true
+                    "desktop": true,
+                    "precommand": "set SPY_BRANCH=__SPY_BRANCH__\nset SPY_COMMIT=__SPY_COMMIT__"
                 },
                 "linux": {
                     "Categories": [
                         "Graphics",
                         "Science"
-                    ]
+                    ],
+                    "precommand": "export SPY_BRANCH=__SPY_BRANCH__ && export SPY_COMMIT=__SPY_COMMIT__"
                 },
                 "osx": {
                     "precommand": "eval \"$($SHELL -l -c \"declare -x\")\"",
@@ -35,7 +37,9 @@
                     "CFBundleIdentifier": "org.spyder-ide.Spyder",
                     "CFBundleVersion": "__PKG_VERSION__",
                     "LSEnvironment": {
-                        "SPYDER_APP": "True"
+                        "SPYDER_APP": "True",
+                        "SPY_BRANCH": "__SPY_BRANCH__",
+                        "SPY_COMMIT": "__SPY_COMMIT__"
                     }
                 }
             }