shasum hash mismatch on CI

[shamoilarsi]

Hey, I'm facing a build issue with my Snap package in GitHub Actions CI. The shasum hash generated during the CI build doesn't match the one stored in the repository, causing build failures when checking for a clean working directory. I'm using the default workflow that comes with @metamask/create-snap for the most part with minor env changes

I assume skipping the "Require clean working directory" step would not be a valid solution and a short discussion of the Consensys Discord server confirmed it.

Here is what the workflow looks like -

jobs:
  prepare:
    name: Prepare
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js
        uses: actions/setup-node@v3
        with:
          node-version-file: '.nvmrc'
          cache: 'yarn'
      - name: Install Yarn dependencies
        run: yarn --immutable

  build:
    name: Build
    runs-on: ubuntu-latest
    needs:
      - prepare
    steps:
      - uses: actions/checkout@v3
      - name: Use Node.js
        uses: actions/setup-node@v3
        with:
          node-version-file: '.nvmrc'
          cache: 'yarn'
      - run: yarn --immutable --immutable-cache
      - run: yarn build
      - name: Cache snap build
        uses: actions/cache@v3
        with:
          path: ./packages/snap/dist
          key: snap-${{ runner.os }}-${{ github.sha }}
      - name: Require clean working directory # <-- failing
        shell: bash
        run: |
          if ! git diff --exit-code; then
            echo "Working tree dirty at end of job"
            exit 1
          fi

Could this mismatch possibly be because of different operating systems? The CI uses ubuntu while I'm using MacOS locally.

Thanks in advance!

[roo-shy]

Hi @shamoilarsi we are currently looking into it, thanks for listing all the details

[roo-shy]

Could you please check if you are building your Snap locally and committing snap.manifest.json to your repo whenever you make changes to the Snap

[shamoilarsi]

yep I do commit and push the updated snap.manifest.json file after every build

here is the build command I'm use on the CI as well as locally.

"build": "yarn workspaces foreach --parallel --topological --verbose run build"

[roo-shy]

Could you please reference your repo (if it's public), so the team could dig in further. Thanks

[shamoilarsi]

ah im sorry its private for now, we're still in development. is there any other way i could help out?

[shamoilarsi]

@roo-shy found this in the build logs

➤ YN0000: [snap]:   • "snap.manifest.json" "shasum" field does not match computed shasum. Got "krMmWuFSqjNv/1afjvwPJDLlfNBZ6vNLMqzPtLaYhkQ=", expected "HNYieK8bTWLiE/upnB6QtzhZLJhTfdspqafZn2hK58I=". (fixed)

here is the error log during the "require clean working directory" step

Run if ! git diff --exit-code; then
diff --git a/packages/snap/snap.manifest.json b/packages/snap/snap.manifest.json
index af52e0e..68bbcc2 [10](https://github.com/renprotocol/ren-snap/actions/runs/12234206793/job/34122964370?pr=104#step:7:11)0644
--- a/packages/snap/snap.manifest.json
+++ b/packages/snap/snap.manifest.json
@@ -7,7 +7,7 @@
     "url": "https://github.com/MetaMask/template-snap-monorepo.git"
   },
   "source": {
-    "shasum": "krMmWuFSqjNv/1afjvwPJDLlfNBZ6vNLMqzPtLaYhkQ=",
+    "shasum": "HNYieK8bTWLiE/upnB6QtzhZLJhTfdspqafZn2hK58I=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",
Working tree dirty at end of job
Error: Process completed with exit code 1.

[roo-shy]

I'm looking into it

[roo-shy]

Hi @shamoilarsi there could be different dependencies, like other yarn.lock or using npm locally but yarn in CI. But that's just a guess too. Numerous factors could impact the shasum. It's hard to say without seeing the code, we could be just guessing so unfortunately without much visibility it's hard to say where the issue is coming from.

[shamoilarsi]

@roo-shy hey it looks like my colleague can build the project locally with the right shasum hash and he is on macOS as well, meaning when he builds the snap locally and pushes the updated shasum the build on CI is successful.
will share get the node and yarn versions we're using. lmk how else can i help fix this issue on my system

[shamoilarsi]

update -
yarn version 3.2.1
my node version was v20 earlier, but even after updating to node version is 22.12.0 the shasum mismatch persists

[shamoilarsi]

@roo-shy I've found the issue. It was due to a mismatch in the env variable between my local system and the CI.
The env was set to development in my local system while in the CI it was empty which lead to different variable values and hence different shasum hashes. Thanks