(f) Merge channel files

Author: per1234

.github/workflows/build.yml

@@ -227,6 +227,9 @@ jobs:
     needs:
       - select-targets
       - start-self-hosted-runner
+    env:
+      # Location of artifacts generated by build.
+      ARTIFACTS_PATH: electron/build/dist/build-artifacts/
     strategy:
       fail-fast: false
       matrix:
@@ -313,11 +316,18 @@ jobs:
           yarn --cwd ./electron/packager/
           yarn --cwd ./electron/packager/ package
 
+      # Both macOS jobs generate a channel file with same path and name. The second job to complete would overwrite the
+      # file generated by the first in the workflow artifact.
+      - name: Prevent macOS channel file overwrite
+        if: runner.os == 'macOS'
+        run: |
+          mv "${{ env.ARTIFACTS_PATH }}/stable-mac.yml" "${{ env.ARTIFACTS_PATH }}/stable-mac-${{ runner.arch }}.yml"
+
       - name: Upload [GitHub Actions]
         uses: actions/upload-artifact@v3
         with:
           name: ${{ env.JOB_TRANSFER_ARTIFACT }}
-          path: electron/build/dist/build-artifacts/
+          path: ${{ env.ARTIFACTS_PATH }}
 
   stop-self-hosted-runner:
     needs:
@@ -341,6 +351,32 @@ jobs:
             --instance-ids "${{ needs.start-self-hosted-runner.outputs.instance-id }}" \
             --region "${{ env.SELF_HOSTED_RUNNER_INSTANCE_REGION }}"
 
+  merge-channel-files:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Download job transfer artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: ${{ env.JOB_TRANSFER_ARTIFACT }}
+          path: ${{ env.JOB_TRANSFER_ARTIFACT }}
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Merge channel files
+        run: |
+          yarn run merge-channel-files "${{ env.JOB_TRANSFER_ARTIFACT }}"
+
+      - name: Upload job transfer artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.JOB_TRANSFER_ARTIFACT }}
+          path: ${{ env.JOB_TRANSFER_ARTIFACT }}
+
   artifacts:
     name: ${{ matrix.artifact.name }} artifact
     needs: build
@@ -429,7 +465,9 @@ jobs:
           path: CHANGELOG.txt
 
   publish:
-    needs: changelog
+    needs:
+      - changelog
+      - merge-channel-files
     if: github.repository == 'arduino/arduino-ide' && (github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'))
     runs-on: ubuntu-latest
     steps:
@@ -450,7 +488,9 @@ jobs:
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
 
   release:
-    needs: changelog
+    needs:
+      - changelog
+      - merge-channel-files
     if: startsWith(github.ref, 'refs/tags/')
     runs-on: ubuntu-latest
     steps:
@@ -490,6 +530,7 @@ jobs:
     # This job must run after all jobs that use the transfer artifact.
     needs:
       - build
+      - merge-channel-files
       - publish
       - release
       - artifacts

package.json

@@ -24,6 +24,7 @@
     "eslint-plugin-unused-imports": "^1.1.1",
     "husky": "^6.0.0",
     "ignore-styles": "^5.0.1",
+    "js-yaml": "^4.1.0",
     "jsdom": "^11.5.1",
     "lerna": "^6.1.0",
     "lint-staged": "^11.0.0",
@@ -57,7 +58,8 @@
     "i18n:pull": "node ./scripts/i18n/transifex-pull.js ./i18n/",
     "themes:pull": "node ./scripts/themes/theme-tokens-pull.js",
     "themes:generate": "node ./scripts/themes/theme-generator.js",
-    "compose-changelog": "yarn --cwd ./arduino-ide-extension compose-changelog"
+    "compose-changelog": "yarn --cwd ./arduino-ide-extension compose-changelog",
+    "merge-channel-files": "node ./scripts/merge-channel-files.js"
   },
   "lint-staged": {
     "./arduino-ide-extension/**/*.{ts,tsx}": [

scripts/merge-channel-files.js

@@ -0,0 +1,38 @@
+// @ts-check
+
+const yaml = require('js-yaml');
+const fs = require('fs');
+const path = require('path');
+
+if (process.argv.length !== 3) {
+  console.error('Missing channel files folder path argument.');
+  process.exit(1);
+}
+
+const channelFilesFolder = process.argv[2];
+// Staging file filename suffixes are named according to `runner.arch`.
+// https://docs.github.com/en/actions/learn-github-actions/contexts#runner-context
+const x86ChannelFilePath = path.join(channelFilesFolder, 'stable-mac-X64.yml');
+const arm64ChannelFilePath = path.join(
+  channelFilesFolder,
+  'stable-mac-ARM64.yml'
+);
+
+const x86Data = yaml.load(
+  fs.readFileSync(x86ChannelFilePath, { encoding: 'utf8' })
+);
+const arm64Data = yaml.load(
+  fs.readFileSync(arm64ChannelFilePath, { encoding: 'utf8' })
+);
+
+const mergedData = x86Data;
+mergedData['files'] = mergedData['files'].concat(arm64Data['files']);
+
+fs.writeFileSync(
+  path.join(channelFilesFolder, 'stable-mac.yml'),
+  yaml.dump(mergedData, { lineWidth: -1 })
+);
+
+// Clean up
+fs.rmSync(x86ChannelFilePath);
+fs.rmSync(arm64ChannelFilePath);