Merge from 5.x: PR #20396

spyder-ide · Feb 1, 2023 · 3e24ec4 · 3e24ec4
2 parents 52ea09d + bcb5886
commit 3e24ec4
Show file tree

Hide file tree

Showing 6 changed files with 76 additions and 29 deletions.
diff --git a/.github/workflows/installer-macos.yml b/.github/workflows/installer-macos.yml
@@ -1,5 +1,10 @@
 on:
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - labeled
     paths:
       - 'installers/macOS/**'
       - '.github/workflows/installer-macos.yml'
@@ -22,19 +27,23 @@ on:
     tags:
       - v*pre*
 
+  workflow_dispatch:
+
 concurrency:
   group: installer-macos-${{ github.ref }}
   cancel-in-progress: true
 
 name: Create macOS App Bundle and DMG
 
 env:
-  IS_PRE: ${{ github.event_name == 'push' && github.ref_type == 'tag' }}
+  IS_PRE: ${{ contains(fromJSON('["workflow_dispatch", "push"]'), github.event_name) || (github.event.action == 'labeled' && github.event.label.name == 'build-installer-artifacts') }}
+  IS_RELEASE: ${{ github.event_name == 'release' }}
 
 jobs:
   matrix_prep:
     name: Determine Build Matrix
     runs-on: macos-11
+    if: github.event.action != 'labeled' || github.event.label.name == 'build-installer-artifacts'
     outputs:
       build_type: ${{ steps.set-matrix.outputs.build_type }}
     steps:
@@ -89,7 +98,7 @@ jobs:
           ${pythonLocation}/bin/python -m pip install -U pip setuptools
           ${pythonLocation}/bin/python -m pip install -r req-build.txt -r req-extras.txt -r req-plugins.txt "${INSTALL_FLAGS[@]}" -e ${GITHUB_WORKSPACE}
       - name: Install Subrepos
-        if: ${{github.event_name == 'pull_request'}}
+        if: ${{github.event_name == 'pull_request' && github.event.action != 'labeled'}}
         run: ${pythonLocation}/bin/python -bb -X dev -W error ${GITHUB_WORKSPACE}/install_dev_repos.py --not-editable --no-install spyder
       - name: Show Build Environment
         run: |
@@ -103,10 +112,10 @@ jobs:
       - name: Build Application Bundle
         run: ${pythonLocation}/bin/python setup.py ${LITE_FLAG} --dist-dir ${DISTDIR}
       - name: Create Keychain
-        if: ${{github.event_name == 'release' || env.IS_PRE == 'true'}}
+        if: ${{env.IS_RELEASE == 'true' || env.IS_PRE == 'true'}}
         run: ./certkeychain.sh "${MACOS_CERTIFICATE}" "${MACOS_CERTIFICATE_PWD}"
       - name: Code Sign Application
-        if: ${{github.event_name == 'release' || env.IS_PRE == 'true'}}
+        if: ${{env.IS_RELEASE == 'true' || env.IS_PRE == 'true'}}
         run: |
           pil=$(${pythonLocation}/bin/python -c "import PIL, os; print(os.path.dirname(PIL.__file__))")
           rm -v ${DISTDIR}/Spyder.app/Contents/Frameworks/liblzma.5.dylib
@@ -117,24 +126,24 @@ jobs:
       - name: Build Disk Image
         run: ${pythonLocation}/bin/python setup.py ${LITE_FLAG} --dist-dir ${DISTDIR} --dmg --no-app
       - name: Sign Disk Image
-        if: ${{github.event_name == 'release' || env.IS_PRE == 'true'}}
+        if: ${{env.IS_RELEASE == 'true' || env.IS_PRE == 'true'}}
         run: ./codesign.sh "${DISTDIR}/${DMGNAME}"
       - name: Notarize Disk Image
-        if: ${{github.event_name == 'release' || env.IS_PRE == 'true'}}
+        if: ${{env.IS_RELEASE == 'true' || env.IS_PRE == 'true'}}
         run: ./notarize.sh -i 30 -p "${APPLICATION_PWD}" "${DISTDIR}/${DMGNAME}"
       - name: Upload Artifact
         uses: actions/upload-artifact@v2
         with:
           path: ${{ env.DISTDIR }}/${{ env.DMGNAME }}
           name: ${{ env.DMGNAME }}
       - name: Get Release
-        if: ${{github.event_name == 'release'}}
+        if: ${{env.IS_RELEASE == 'true'}}
         id: get_release
         env:
           GITHUB_TOKEN: ${{ github.token }}
         uses: bruceadams/[email protected]
       - name: Upload Release Asset
-        if: ${{github.event_name == 'release'}}
+        if: ${{env.IS_RELEASE == 'true'}}
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ github.token }}

diff --git a/.github/workflows/installer-win.yml b/.github/workflows/installer-win.yml
@@ -1,6 +1,11 @@
 # Based on https://github.com/tlambert03/napari/blob/master/.github/workflows/make_bundle.yml
 on:
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - labeled
     paths:
       - 'installers/Windows/**'
       - '.github/workflows/installer-win.yml'
@@ -23,31 +28,35 @@ on:
     tags:
       - v*pre*
 
+  workflow_dispatch:
+
 concurrency:
   group: installer-win-${{ github.ref }}
   cancel-in-progress: true
 
 name: Create Windows Installer
 
 env:
-  IS_PRE: ${{ github.event_name == 'push' && github.ref_type == 'tag' }}
+  IS_PRE: ${{ contains(fromJSON('["workflow_dispatch", "push"]'), github.event_name) || (github.event.action == 'labeled' && github.event.label.name == 'build-installer-artifacts') }}
+  IS_STANDARD_PR: ${{ github.event_name == 'pull_request' && github.event.action != 'labeled' }}
 
 jobs:
   build:
     name: Windows installer
     runs-on: windows-latest
+    if: github.event.action != 'labeled' || github.event.label.name == 'build-installer-artifacts'
     strategy:
       matrix:
         build_type: ['Lite', 'Full']
     env:
-      UNWANTED_PACKAGES: ${{github.event_name == 'pull_request' && 'pip spyder-kernels python-slugify Rtree QDarkStyle PyNaCl psutil' || 'pip python-slugify Rtree PyNaCl psutil' }}
+      UNWANTED_PACKAGES: ${{github.event_name == 'pull_request' && github.event.action != 'labeled' && 'pip spyder-kernels python-slugify Rtree QDarkStyle PyNaCl psutil' || 'pip python-slugify Rtree PyNaCl psutil' }}
       SKIP_PACKAGES: 'bcrypt slugify'
-      ADD_PACKAGES: ${{github.event_name == 'pull_request' && 'spyder_kernels blib2to3 _black_version blackd rtree qdarkstyle nacl psutil' || 'blib2to3 _black_version blackd rtree nacl psutil' }}
+      ADD_PACKAGES: ${{github.event_name == 'pull_request' && github.event.action != 'labeled' && 'spyder_kernels blib2to3 _black_version blackd rtree qdarkstyle nacl psutil' || 'blib2to3 _black_version blackd rtree nacl psutil' }}
       PYNSIST_REQ: pynsist==2.7
-      EXTRA_FLAG: ${{ matrix.build_type == 'Full' && github.event_name == 'pull_request' && '-ep installers/Windows/req-extras-pull-request.txt' || matrix.build_type == 'Lite' && github.event_name == 'pull_request' && '-ep installers/Windows/req-pull-request.txt' || matrix.build_type == 'Full' && '-ep installers/Windows/req-extras-release.txt' || '-ep installers/Windows/req-release.txt' }}
+      EXTRA_FLAG: ${{ matrix.build_type == 'Full' && github.event_name == 'pull_request' && github.event.action != 'labeled' && '-ep installers/Windows/req-extras-pull-request.txt' || matrix.build_type == 'Lite' && github.event_name == 'pull_request' && github.event.action != 'labeled' && '-ep installers/Windows/req-pull-request.txt' || matrix.build_type == 'Full' && '-ep installers/Windows/req-extras-release.txt' || '-ep installers/Windows/req-release.txt' }}
       SUFFIX_FLAG: ${{ matrix.build_type == 'Lite' && '-s lite' || '-s full' }}
       TEMPLATE_FAG: '-t installers/Windows/assets/nsist/spyder.nsi'
-      EXE_NAME: ${{ matrix.build_type == 'Lite' && github.event_name == 'pull_request' && 'Spyder_64bit_lite.exe' || matrix.build_type == 'Lite' && 'Spyder_64bit_lite.exe' || 'Spyder_64bit_full.exe' }}
+      EXE_NAME: ${{ matrix.build_type == 'Lite' && github.event_name == 'pull_request' && github.event.action != 'labeled' && 'Spyder_64bit_lite.exe' || matrix.build_type == 'Lite' && 'Spyder_64bit_lite.exe' || 'Spyder_64bit_full.exe' }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

diff --git a/.github/workflows/installers-conda.yml b/.github/workflows/installers-conda.yml
@@ -1,5 +1,10 @@
 on:
   pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - labeled
     paths:
       - 'installers-conda/**'
       - '.github/workflows/installers-conda.yml'
@@ -21,20 +26,26 @@ on:
     tags:
       - v*pre*
 
+  workflow_dispatch:
+
 concurrency:
   group: installers-conda-${{ github.ref }}
   cancel-in-progress: true
 
 name: Create conda-based installers for Windows, macOS, and Linux
 
 env:
-  IS_PRE: ${{ github.event_name == 'push' && github.ref_type == 'tag' }}
+  IS_STANDARD_PR: ${{ github.event_name == 'pull_request' && github.event.action != 'labeled' }}
+  IS_BUILD: ${{ github.event.action != 'labeled' || github.event.label.name == 'build-installer-artifacts' }}
+  IS_LABELED_PR: ${{ github.event.action == 'labeled' && github.event.label.name == 'build-installer-artifacts' }}
+  IS_RELEASE: ${{ github.event_name == 'release' }}
+  IS_PRE: ${{ contains(fromJSON('["workflow_dispatch", "push"]'), github.event_name) || (github.event.action == 'labeled' && github.event.label.name == 'build-installer-artifacts') }}
 
 jobs:
   build-noarch-pkgs:
     name: Build ${{ matrix.pkg }}
     runs-on: ubuntu-latest
-    if: github.event_name == 'pull_request'
+    if: github.event_name == 'pull_request' && github.event.action != 'labeled'
     strategy:
       matrix:
         pkg: ["python-lsp-server", "qtconsole"]
@@ -75,12 +86,15 @@ jobs:
   build-matrix:
     name: Determine Build Matrix
     runs-on: ubuntu-latest
+    if: github.event.action != 'labeled' || github.event.label.name == 'build-installer-artifacts'
     outputs:
       target_platform: ${{ steps.build-matrix.outputs.target_platform }}
       include: ${{ steps.build-matrix.outputs.include }}
       python_version: ${{ steps.build-matrix.outputs.python_version }}
+
     steps:
-    - id: build-matrix
+    - name: Determine Build Matrix
+      id: build-matrix
       run: |
         target_platform="'osx-64', 'linux-64'"
         include="\
@@ -89,7 +103,7 @@ jobs:
         "
         python_version="'3.9'"
 
-        if [[ ${GITHUB_EVENT_NAME} == 'pull_request' ]]; then
+        if [[ $IS_STANDARD_PR == 'true' ]]; then
             target_platform=$target_platform", 'win-64'"
             include=$include",{'os': 'windows-latest', 'target-platform': 'win-64'}"
         fi
@@ -98,13 +112,19 @@ jobs:
         echo "include=[$include]" >> $GITHUB_OUTPUT
         echo "python_version=[$python_version]" >> $GITHUB_OUTPUT
 
+    - name: Remove Label
+      if: github.event.action == 'labeled'
+      uses: actions-ecosystem/action-remove-labels@v1
+      with:
+        labels: build-installer-artifacts
+
   build-installers:
     name: Build installer for ${{ matrix.target-platform }} Python-${{ matrix.python-version }}
     runs-on: ${{ matrix.os }}
     needs:
       - build-matrix
       - build-noarch-pkgs
-    if: ${{ ! failure() && ! cancelled() }}
+    if: ${{ ! failure() && ! cancelled() && needs.build-matrix.result == 'success' }}
     strategy:
       matrix:
         target-platform: ${{fromJson(needs.build-matrix.outputs.target_platform)}}
@@ -121,7 +141,7 @@ jobs:
       MACOS_INSTALLER_CERTIFICATE: ${{ secrets.MACOS_INSTALLER_CERTIFICATE }}
       APPLICATION_PWD: ${{ secrets.APPLICATION_PWD }}
       CONSTRUCTOR_TARGET_PLATFORM: ${{ matrix.target-platform }}
-      STATUS: ${{ needs.build-noarch-pkgs.result }}
+      BNP_STATUS: ${{ needs.build-noarch-pkgs.result }}
       MAT_STATUS: ${{ needs.build-matrix.result }}
 
     steps:
@@ -159,7 +179,7 @@ jobs:
           env
 
       - name: Download Local Conda Packages
-        if: github.event_name == 'pull_request'
+        if: env.IS_STANDARD_PR
         uses: actions/download-artifact@v3
         with:
           path: ${{ env.ARTIFACTS_PATH }}
@@ -182,13 +202,13 @@ jobs:
       - name: Build ${{ matrix.target-platform }} conda packages
         run: |
           pkgs=("spyder")
-          if [[ $GITHUB_EVENT_NAME == "pull_request" ]]; then
+          if [[ $IS_STANDARD_PR == "true" ]]; then
               pkgs+=("spyder-kernels")
           fi
           python build_conda_pkgs.py --build ${pkgs[@]}
 
       - name: Create Keychain
-        if: (github.event_name == 'release' || env.IS_PRE == 'true') && runner.os == 'macOS'
+        if: runner.os == 'macOS' && (env.IS_RELEASE == 'true' || env.IS_PRE == 'true')
         run: |
           ./certkeychain.sh "${MACOS_CERTIFICATE_PWD}" "${MACOS_CERTIFICATE}" "${MACOS_INSTALLER_CERTIFICATE}"
           CNAME=$(security find-identity -p codesigning -v | pcregrep -o1 "\(([0-9A-Z]+)\)")
@@ -226,7 +246,7 @@ jobs:
           fi
 
       - name: Notarize package installer
-        if: (github.event_name == 'release' || env.IS_PRE == 'true') && runner.os == 'macOS'
+        if: runner.os == 'macOS' && (env.IS_RELEASE == 'true' || env.IS_PRE == 'true')
         run: ./notarize.sh -p $APPLICATION_PWD $PKG_FILE
 
       - name: Upload Artifact

diff --git a/RELEASE.md b/RELEASE.md
@@ -133,11 +133,17 @@ To release a new version of Spyder you need to follow these steps:
 * Update version in `__init__.py` (set release version, remove 'dev0', add 'preX'), then
 
       git add .
-      git commit -m "Release X.X.XpreX"
-      git tag vX.X.XpreX
-      git push upstream --tags
+      git commit -m "Release X.X.XpreX [ci skip]"
+      git push upstream 5.x
 
-* If workflows succeed, proceed to steps to publish the release; otherwise merge a fix PR and repeat previous steps with incremented 'preX'
+* Manually activate the following workflows (see [Running a workflow](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow#running-a-workflow)):
+    - Create Windows Installer
+    - Create macOS App Bundle and DMG
+    - Create conda-based installers for Windows, macOS, and Linux
+
+* Download and test the installation of the resulting artifacts.
+
+* If either of the previous two steps fail merge a fix PR and begin again with incremented 'preX'.
 
 ## To do the release
 

diff --git a/installers-conda/build_conda_pkgs.py b/installers-conda/build_conda_pkgs.py
@@ -48,6 +48,7 @@
 class BuildCondaPkg:
     """Base class for building a conda package for conda-based installer"""
     name = None
+    norm = True
     source = None
     feedstock = None
     shallow_ver = None
@@ -115,7 +116,8 @@ def _build_cleanup(self):
 
     def _get_version(self):
         """Get source version using setuptools_scm"""
-        self.version = get_version(self._bld_src).split('+')[0]
+        v = get_version(self._bld_src, normalize=self.norm)
+        self.version = v.lstrip('v').split('+')[0]
 
     def _patch_source(self):
         pass
@@ -193,6 +195,7 @@ def build(self):
 
 class SpyderCondaPkg(BuildCondaPkg):
     name = "spyder"
+    norm = False
     source = os.environ.get('SPYDER_SOURCE', HERE.parent)
     feedstock = "https://github.com/conda-forge/spyder-feedstock"
     shallow_ver = "v5.3.2"

diff --git a/installers-conda/build_installers.py b/installers-conda/build_installers.py
@@ -129,7 +129,7 @@
 yaml.indent(mapping=2, sequence=4, offset=2)
 indent4 = partial(indent, prefix="    ")
 
-SPYVER = get_version(SPYREPO).strip().split("+")[0]
+SPYVER = get_version(SPYREPO, normalize=False).lstrip('v').split("+")[0]
 
 specs = {
     "spyder": "=" + SPYVER,