fix(snap): make snapcraft.yaml compatible with remote-builds (#322)

* fix(snap): make snapcraft.yaml compatible with remote-builds * fix(snap): (fix #300) remotely build snaps from GH * fix(ci): don't run snap workflows in parallel Co-authored-by: Cristovao Cordeiro <[email protected]>
canonical · Oct 23, 2023 · b255ff3 · b255ff3
1 parent 03c4087
commit b255ff3
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 53 deletions.
diff --git a/.github/workflows/snap.yml b/.github/workflows/snap.yml
@@ -3,98 +3,121 @@ name: Pebble snap
 on:
   pull_request:
     branches: [master]
+  push:
+    branches: [master]
   release:
     types: [published]
 
+# We don't want this workflow to have multiple runs in parallel because
+# what could happen is that a slow-running and older execution will upload
+# an older snap to `edge`, after the newer and latest snap has already been released.
+concurrency: ${{ github.workflow }}
+
 env:
   SNAP_NAME: pebble
+  DEFAULT_TRACK: latest
+  DEFAULT_RISK: edge
 
 jobs:
-  build:
+  snaps:
     runs-on: ubuntu-latest
-    outputs:
-      pebble-snap: ${{ steps.build-pebble-snap.outputs.snap }}
-
+    strategy:
+      fail-fast: false
+      matrix:
+        arch: [amd64, arm64, ppc64el, armhf, s390x]
     steps:
       - name: Checkout Pebble repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Build Pebble Snap
-        id: build-pebble-snap
-        uses: snapcore/action-build@v1
+      - name: Set LP credentials for remote build
+        id: set-local-paths
+        run: |
+          lp_creds_path="$HOME/.local/share/snapcraft/provider/launchpad"
+          mkdir -p $lp_creds_path
+          echo '${{ secrets.LP_CREDENTIALS }}' > ${lp_creds_path}/credentials
+          git config --global user.email "${{ secrets.PEBBLE_DEV_MAILING_LIST}}"
+          git config --global user.name "pebble-dev"
 
-      - name: Attach pebble snap to GH workflow execution
-        uses: actions/upload-artifact@v2
-        with:
-          name: ${{ steps.build-pebble-snap.outputs.snap }}
-          path: ${{ steps.build-pebble-snap.outputs.snap }}
+          echo "home=$HOME" >> $GITHUB_OUTPUT
 
-  test:
-    runs-on: ubuntu-latest
-    needs: [build]
-    outputs:
-      pebble-version: ${{ steps.install-pebble.outputs.version }}
+      - name: Build ${{ env.SNAP_NAME }} Snap for ${{ matrix.arch }}
+        id: build-snap
+        uses: snapcore/action-build@v1.1.3
+        with:
+          snapcraft-args: remote-build --build-for=${{ matrix.arch }} --launchpad-accept-public-upload
 
-    steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/upload-artifact@v3
+        if: failure()
         with:
-          name: ${{ needs.build.outputs.pebble-snap }}
+          name: snapcraft-logs
+          path: |
+            ${{ steps.set-local-paths.outputs.home }}/.cache/snapcraft/log/
+            ${{ steps.set-local-paths.outputs.home }}/.local/state/snapcraft/log/
+            ${{ env.SNAP_NAME }}_*.txt
 
-      - name: Install the Pebble snap
-        id: install-pebble
+      - name: Install and test ${{ steps.build-snap.outputs.snap }}
+        # NOTE: this line can be adjusted if we start supporting multi-arch runners
+        if: ${{ matrix.arch	== 'amd64' }} 
         run: |
           set -ex
-          # Install the Pebble snap from the artifact built in the previous job
-          sudo snap install --dangerous --classic ${{ needs.build.outputs.pebble-snap }}
+          sudo snap install --dangerous --classic ${{ steps.build-snap.outputs.snap }}
 
-          # Make sure Pebble is installed
-          echo "version=$(pebble version --client)" >> "$GITHUB_OUTPUT"
+          # Make sure it is installed
+          pebble version --client
+          
+          # Run smoke test
+          pebble enter --create-dirs exec echo Hello | grep Hello
 
-      - name: Run smoke test
-        run: pebble enter --create-dirs exec echo Hello | grep Hello
+      - name: Attach ${{ steps.build-snap.outputs.snap }} to GH workflow execution
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ steps.build-snap.outputs.snap }}
+          path: ${{ steps.build-snap.outputs.snap }}
+
+      - name: Release ${{ steps.build-snap.outputs.snap }} to ${{ env.DEFAULT_TRACK }}/${{ env.DEFAULT_RISK }}  
+        if: ${{ github.event_name != 'pull_request' }}
+        uses: snapcore/action-publish@v1
+        env:
+          SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAPCRAFT_STORE_CREDENTIALS }}
+        with:
+          snap: ${{ steps.build-snap.outputs.snap }}
+          release: ${{ env.DEFAULT_TRACK }}/${{ env.DEFAULT_RISK }}
 
   promote:
     if: ${{ github.event_name == 'release' }}
     runs-on: ubuntu-latest
-    needs: [test]
+    needs: [snaps]
     strategy:
       fail-fast: false
       matrix:
         arch: [amd64, arm64, ppc64el, armhf, s390x]
     env:
-      TRACK: latest
-      DEFAULT_RISK: edge
+      TO_TRACK: latest
       TO_RISK: candidate
     steps:
       - name: Install Snapcraft
         run: sudo snap install snapcraft --classic
-
-      - name: Wait for ${{ needs.test.outputs.pebble-version }} to be released
+
+      - name: Get current ${{ matrix.arch }} ${{ env.SNAP_NAME }} snap in ${{ env.TO_TRACK }}/${{ env.TO_RISK }}
+        id: get-snap
         env:
           SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAPCRAFT_STORE_CREDENTIALS }}
         run: |
-          while ! `snapcraft status ${{ env.SNAP_NAME }} --track ${{ env.TRACK }} --arch ${{ matrix.arch }} \
-              | grep "${{ env.DEFAULT_RISK }}" \
-              | awk -F' ' '{print $2}' \
-              | grep -Fxq "${{ needs.test.outputs.pebble-version }}"`; do
-            echo "[${{ matrix.arch }}] Waiting for ${{ needs.test.outputs.pebble-version }} \
-          to be released to ${{ env.TRACK }}/${{ env.DEFAULT_RISK }}..."
-            sleep 10
-          done
+          revision="$(snapcraft status ${{ env.SNAP_NAME }} \
+            --track ${{ env.DEFAULT_TRACK }} --arch ${{ matrix.arch }} \
+            | grep "${{ env.DEFAULT_RISK }}" | awk -F' ' '{print $3}')"
+
+          echo "revision=$revision" >> $GITHUB_OUTPUT
 
       # It would be easier to use `snapcraft promote`, but there's an error when trying
       # to avoid the prompt with the "--yes" option: 
       # > 'latest/edge' is not a valid set value for --from-channel when using --yes.
-      - name: Promote ${{ needs.test.outputs.pebble-version }} (${{ matrix.arch }}) to ${{ env.TO_RISK }}
+      - name: Promote ${{ env.SNAP_NAME }} snap rev${{ steps.get-snap.outputs.revision }} to ${{ env.TO_TRACK }}/${{ env.TO_RISK }}
         env:
           SNAPCRAFT_STORE_CREDENTIALS: ${{ secrets.SNAPCRAFT_STORE_CREDENTIALS }}
         run: |
-          revision="$(snapcraft status ${{ env.SNAP_NAME }} \
-            --track ${{ env.TRACK }} --arch ${{ matrix.arch }} \
-            | grep "${{ env.DEFAULT_RISK }}" | awk -F' ' '{print $3}')"
-
           snapcraft release ${{ env.SNAP_NAME }} \
-            $revision \
-            ${{ env.TRACK }}/${{ env.TO_RISK }}
+            ${{ steps.get-snap.outputs.revision }} \
+            ${{ env.TO_TRACK }}/${{ env.TO_RISK }}
diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
@@ -34,12 +34,9 @@ parts:
     source: .
     build-snaps:
       - go/1.20/stable
-    build-environment:
-      - CGO_ENABLED: 0
-      - GOFLAGS: -trimpath -ldflags=-w -ldflags=-s
     override-build: |
       go generate ./cmd
-      craftctl default
+      CGO_ENABLED=0 go build -trimpath -ldflags=-w -ldflags=-s -o $CRAFT_PART_INSTALL/bin/pebble ./cmd/pebble
 
   pebble-release-data:
     plugin: nil