Improve building Homebrew*.pkg

- split jobs into build/test/deploy - test package on both macOS Intel and Apple Silicon - cleanup some argument handling - use `HOMEBREW_MACOS_OLDEST_SUPPORTED` naming to be consistent with `brew.sh` - note in `brew.sh` that `Distribution.xml` also needs updated (and do so) - various other little bits of style cleanup
Homebrew · Oct 3, 2023 · df297ee · df297ee
1 parent d0eef12
commit df297ee
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 40 deletions.
diff --git a/.github/workflows/build-pkg.yml b/.github/workflows/build-pkg.yml
@@ -7,22 +7,21 @@ on:
   release:
     types:
       - published
-
+env:
+  PKG_APPLE_DEVELOPER_TEAM_ID: ${{ secrets.PKG_APPLE_DEVELOPER_TEAM_ID }}
+  HOMEBREW_NO_ANALYTICS_THIS_RUN: 1
+  HOMEBREW_NO_ANALYTICS_MESSAGE_OUTPUT: 1
 jobs:
   build:
     if: github.repository_owner == 'Homebrew'
-    runs-on: macos-13
-    permissions:
-      # To write assets to GitHub release
-      contents: write
+    runs-on: macos-latest
+    outputs:
+      installer_path: "Homebrew-${{ steps.homebrew-version.outputs.version }}.pkg"
     env:
       TEMPORARY_CERTIFICATE_FILE: 'homebrew_developer_id_installer_certificate.p12'
       TEMPORARY_KEYCHAIN_FILE: 'homebrew_installer_signing.keychain-db'
-      # Set to the latest supported version of macOS
-      MIN_MACOS_VERSION: '12.0'
-      PKG_APPLE_DEVELOPER_TEAM_ID: ${{ secrets.PKG_APPLE_DEVELOPER_TEAM_ID }}
-      HOMEBREW_NO_ANALYTICS_THIS_RUN: 1
-      HOMEBREW_NO_ANALYTICS_MESSAGE_OUTPUT: 1
+      # Set to the oldest supported version of macOS
+      HOMEBREW_MACOS_OLDEST_SUPPORTED: '12.0'
     steps:
       - name: Remove existing API cache (to force update)
         run: rm -rvf ~/Library/Caches/Homebrew/api
@@ -58,7 +57,9 @@ jobs:
         run: security import "${RUNNER_TEMP}/${TEMPORARY_CERTIFICATE_FILE}"
                              -k "${RUNNER_TEMP}/${TEMPORARY_KEYCHAIN_FILE}"
                              -P "${PKG_APPLE_SIGNING_CERTIFICATE_PASSWORD}"
-                             -t cert -f pkcs12 -A
+                             -t cert
+                             -f pkcs12
+                             -A
 
       - name: Clean up temporary certificate file
         if: ${{ always() }}
@@ -72,7 +73,7 @@ jobs:
           persist-credentials: false
 
       - name: Get Homebrew version from Git
-        id: print-version
+        id: homebrew-version
         run: echo "version=$(git -C brew describe --tags --always)" >> "${GITHUB_OUTPUT}"
 
       - name: Copy Homebrew API cache to brew subdirectory
@@ -86,13 +87,14 @@ jobs:
         # binaries so it needs to be excluded from notarization.
         run: pkgbuild --root brew
                       --scripts brew/package/scripts
-                      --identifier "sh.brew.homebrew"
-                      --version ${{ steps.print-version.outputs.version }}
-                      --install-location "/opt/homebrew"
+                      --identifier sh.brew.homebrew
+                      --version "${{ steps.homebrew-version.outputs.version }}"
+                      --install-location /opt/homebrew
                       --filter .DS_Store
                       --filter "(.*)/Library/Homebrew/test/support/fixtures/"
-                      --min-os-version "${MIN_MACOS_VERSION}"
-                      --sign "${PKG_APPLE_DEVELOPER_TEAM_ID}" Homebrew.pkg
+                      --min-os-version "${HOMEBREW_MACOS_OLDEST_SUPPORTED}"
+                      --sign "${PKG_APPLE_DEVELOPER_TEAM_ID}"
+                      Homebrew.pkg
 
       - name: Convert Homebrew license file to RTF
         run: (printf "### " && cat brew/LICENSE.txt) |
@@ -101,8 +103,38 @@ jobs:
       - name: Build Homebrew installer package
         run: productbuild --resources brew/package/resources
                           --distribution brew/package/Distribution.xml
-                          --package-path Homebrew.pkg Homebrew-${{ steps.print-version.outputs.version }}.pkg
+                          --package-path Homebrew.pkg
                           --sign "${PKG_APPLE_DEVELOPER_TEAM_ID}"
+                          Homebrew-${{ steps.homebrew-version.outputs.version }}.pkg
+
+      - name: Clean up temporary macOS keychain
+        if: ${{ always() }}
+        run: |
+          if [[ -f "${RUNNER_TEMP}/${TEMPORARY_KEYCHAIN_FILE}" ]]
+          then
+            security delete-keychain "${RUNNER_TEMP}/${TEMPORARY_KEYCHAIN_FILE}"
+          fi
+
+      - name: Upload installer to GitHub Actions
+        uses: actions/upload-artifact@v3
+        with:
+          name: Homebrew-${{ steps.homebrew-version.outputs.version }}.pkg
+          path: Homebrew-${{ steps.homebrew-version.outputs.version }}.pkg
+  test:
+    needs: build
+    runs-on: ${{ matrix.runner }}
+    strategy:
+      matrix:
+        include:
+          # Intel (free)
+          - runner: macos-latest
+          # Apple Silicon (paid)
+          - runner: macos-latest-xlarge
+    steps:
+      - name: Download installer from GitHub Actions
+        uses: actions/download-artifact@v3
+        with:
+          name: "${{ needs.build.outputs.installer_path }}"
 
       - name: Remove existing Homebrew installations
         run: |
@@ -114,7 +146,7 @@ jobs:
         run: echo | sudo tee /var/log/install.log
 
       - name: Install Homebrew from installer package
-        run: sudo installer -verbose -pkg Homebrew-${{ steps.print-version.outputs.version }}.pkg -target /
+        run: sudo installer -verbose -pkg "${{ needs.build.outputs.installer_path }}" -target /
 
       - name: Output installer logs
         if: ${{ always() }}
@@ -128,7 +160,7 @@ jobs:
         run: echo | sudo tee /var/log/install.log
 
       - name: Reinstall Homebrew from installer package
-        run: sudo installer -verbose -pkg Homebrew-${{ steps.print-version.outputs.version }}.pkg -target /
+        run: sudo installer -verbose -pkg "${{ needs.build.outputs.installer_path }}" -target /
 
       - name: Output installer logs (again)
         if: ${{ always() }}
@@ -138,30 +170,25 @@ jobs:
 
       - run: brew doctor
 
+  deploy:
+    needs: test
+    runs-on: macos-latest
+    permissions:
+      # To write assets to GitHub release
+      contents: write
+    steps:
+      - uses: actions/download-artifact@v3
+
       - name: Notarize Homebrew installer package
         env:
           PKG_APPLE_ID_EMAIL: ${{ secrets.PKG_APPLE_ID_EMAIL }}
           PKG_APPLE_ID_APP_SPECIFIC_PASSWORD: ${{ secrets.PKG_APPLE_ID_APP_SPECIFIC_PASSWORD }}
-        run: xcrun notarytool submit Homebrew-${{ steps.print-version.outputs.version }}.pkg
+        run: xcrun notarytool submit "${{ needs.build.outputs.installer_path }}"
                                     --team-id  "${PKG_APPLE_DEVELOPER_TEAM_ID}"
                                     --apple-id "${PKG_APPLE_ID_EMAIL}"
                                     --password "${PKG_APPLE_ID_APP_SPECIFIC_PASSWORD}"
                                     --wait
 
-      - name: Clean up temporary macOS keychain
-        if: ${{ always() }}
-        run: |
-          if [[ -f "${RUNNER_TEMP}/${TEMPORARY_KEYCHAIN_FILE}" ]]
-          then
-            security delete-keychain "${RUNNER_TEMP}/${TEMPORARY_KEYCHAIN_FILE}"
-          fi
-
-      - name: Upload installer to GitHub Actions
-        uses: actions/upload-artifact@v3
-        with:
-          name: Homebrew ${{ steps.print-version.outputs.version }}
-          path: Homebrew-${{ steps.print-version.outputs.version }}.pkg
-
       - name: Install gh
         run: brew install gh
 
@@ -170,5 +197,5 @@ jobs:
         env:
           GH_TOKEN: ${{ github.token }}
         run: gh release upload --repo Homebrew/brew
-                               "${GITHUB_REF//refs\/tags\//}"
-                               Homebrew-${{ steps.print-version.outputs.version }}.pkg
+                                "${GITHUB_REF//refs\/tags\//}"
+                                "${{ needs.build.outputs.installer_path }}"
diff --git a/Library/Homebrew/brew.sh b/Library/Homebrew/brew.sh
@@ -510,7 +510,8 @@ esac
 HOMEBREW_MACOS_NEWEST_UNSUPPORTED="15"
 # TODO: bump version when new macOS is released and update references in:
 # - docs/Installation.md
-# - MIN_MACOS_VERSION in .github/workflows/build-pkg.yml
+# - HOMEBREW_MACOS_OLDEST_SUPPORTED in .github/workflows/build-pkg.yml
+# - `os-version min` in package/Distribution.xml
 # - https://github.com/Homebrew/install/blob/HEAD/install.sh
 HOMEBREW_MACOS_OLDEST_SUPPORTED="12"
 HOMEBREW_MACOS_OLDEST_ALLOWED="10.11"

diff --git a/package/Distribution.xml b/package/Distribution.xml
@@ -4,7 +4,7 @@
   <options customize="never" hostArchitectures="x86_64,arm64" rootVolumeOnly="true"/>
   <volume-check>
     <allowed-os-versions>
-        <os-version min="11.0.0"/>
+        <os-version min="12.0.0"/>
     </allowed-os-versions>
   </volume-check>
   <choices-outline>
@@ -27,7 +27,7 @@
   <license file="LICENSE.rtf"/>
   <conclusion file="CONCLUSION.rtf" />
   <allowed-os-versions>
-    <os-version min="11.0"/>
+    <os-version min="12.0.0"/>
   </allowed-os-versions>
 
   <script>