From bc2df1ded861a5d0ac5d4330245d82f11d0c7da7 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 4 Oct 2023 09:56:33 -0700 Subject: [PATCH] Update manual release procedure documentation to reflect implementation of automated builds for macOS ARM Previously, the production of the builds for the Apple Silicon host target was a manual procedure. This was done due to the lack of availability of GitHub hosted runner machines of that architecture. Fortunately such runners are now available, which allowed us to set up automated builds for this target. For this reason, it is no longer necessary to maintain documentation of the manual release procedure for that target. --- docs/internal/release-procedure.md | 85 +----------------------------- package.json | 3 +- scripts/merge-channel-files.js | 48 ----------------- 3 files changed, 2 insertions(+), 134 deletions(-) delete mode 100644 scripts/merge-channel-files.js diff --git a/docs/internal/release-procedure.md b/docs/internal/release-procedure.md index 89768c471..ce4daf2a7 100644 --- a/docs/internal/release-procedure.md +++ b/docs/internal/release-procedure.md @@ -177,9 +177,7 @@ replacing `` with the version you want. Then create a PR and merge ## Manual build -Creating the release for Ubuntu 18.04 ([arduino/arduino-ide#2018](https://github.com/arduino/arduino-ide/issues/2018)) and macOS M1 ([arduino/arduino-ide#408](https://github.com/arduino/arduino-ide/issues/408)) is a manual procedure. - -### Ubuntu 18.04 +Creating the release for Ubuntu 18.04 ([arduino/arduino-ide#2018](https://github.com/arduino/arduino-ide/issues/2018)) is a manual procedure: - Prerequisites: - Ask the DevOps team for an EC2 instance with at least 8 GB of RAM. @@ -232,87 +230,6 @@ Creating the release for Ubuntu 18.04 ([arduino/arduino-ide#2018](https://github - `arduino-ide_${VERSION}_Linux_64bit.zip`, and - `stable-linux.yml` -### macOS M1 - -- Prerequisites: - - - You need access to the shared Mac Mini at Toolbox. Use TeamViewer. - - You have access to the `FT Web Tooling` 1Password vault. - -- Clone: - - ```sh - BRANCH="" - git clone --single-branch --branch $BRANCH https://github.com/arduino/arduino-ide.git - ``` - -- Setup: - - - Download the `Pro-IDE-Certificates.p12` file from the `Arduino Pro IDE Apple Developer ID Certificate .p12 format` 1Password vault item and put it somewhere on the Mac Mini. This example assumes you put the `.p12` file in the `arduino-ide` repository root, and your `cwd` is also in the `arduino-ide` repository root. - - The following environment variables must be available from the shell: - - - `AC_PASSWORD`: From the `Arduino Apple developer ID App Specific Password` 1Password vault item - - `AC_USERNAME`: From the `Arduino Apple developer ID App Specific Password` 1Password vault item - - `AC_TEAM_ID`: "KT7ZWMCJT" - - `CSC_KEY_PASSWORD`: from the `Arduino Pro IDE Apple Developer ID certificate keychain password` 1Password vault item - - `CSC_LINK`: Path to the `Pro-IDE-Certificates.p12` file on the Mac Mini - - `IS_RELEASE`: "true" - - `CAN_SIGN`: "true" - - `MACOS_FORCE_NOTARIZE`: "true" - - ```sh - export AC_PASSWORD="***" - export AC_USERNAME="***" - export AC_TEAM_ID="7KT7ZWMCJT" - export CSC_KEY_PASSWORD="***" - export CSC_LINK="`pwd`/Pro-IDE-Certificates.p12" - export IS_RELEASE="true" - export CAN_SIGN="true" - export MACOS_FORCE_NOTARIZE="true" - export CI="true" - ``` - -- Build: - - ```sh - ./scripts/package.sh - ``` - - > Make sure to change directory, and execute the script from the root of the `arduino-ide` repository. - -- Verify: - - Since you cannot drag and drop via TeamViewer, you will install the app from a command line. This example puts the IDE2 into the Desktop. Do **NOT** try to bypass the installation with a double click and open from the UI. The `node_modules` folder of the source code is implicitly in the `$PATH`, and you want to verify if the app is fully functional without the `node_modules` folder. - - ```sh - VERSION="" - hdiutil attach ./electron-app/dist/arduino-ide_${VERSION}_macOS_arm64.dmg \ - && cp -R /Volumes/Arduino\ IDE\ ${VERSION}-arm64/Arduino\ IDE.app ~/Desktop \ - && hdiutil unmount /Volumes/Arduino\ IDE\ ${VERSION}-arm64 \ - && codesign -dv --verbose=4 ~/Desktop/Arduino\ IDE.app \ - && ~/Desktop/Arduino\ IDE.app/Contents/MacOS/Arduino\ IDE - ``` - -- Cleanup: - - - You **MUST** close the shell after the build. - - You **MUST** delete the `.p12` file and empty the trash afterward. - -- Artifacts: - - You have to upload the following artifacts from `./arduino-ide/electron-app/dist` to S3, but first, you must create the final channel file from the `latest-mac.yaml`: - - `arduino-ide_${VERSION}_macOS_arm64.dmg`, - - `arduino-ide_${VERSION}_macOS_arm64.zip`, and - - `stable-mac.yml` - - To create the final channel file, do the followings: - - Copy the `stable-mac.yml` file from the Mac Mini to a folder and rename it to `stable-mac-ARM64.yml`. - - Download the `stable-mac.yaml` produced by GitHub Actions from the latest release, rename it to `stable-mac-X64.yml`, and put it in the same folder where you put the file from the Mac Mini. - - Run the channel file merger: - ```sh - node ./scripts/merge-channel-files.js ./path/to/folder/with/channel/files --no-cleanup - ``` - > Although, the `--no-cleanup` flag is not mandatory to merge the channel files, it instructs the merger to keep the original channel files. - - You have the merged channel file that you need to upload to S3. - ### FAQ - Q: I see no `stable` channel files, only `latest`. diff --git a/package.json b/package.json index 866e9ed64..61113c1ea 100644 --- a/package.json +++ b/package.json @@ -22,8 +22,7 @@ "eslint-plugin-unused-imports": "^2.0.0", "husky": "^6.0.0", "ignore-styles": "^5.0.1", - "js-yaml": "^4.1.0", - "lerna": "^6.1.0", + "lerna": "^7.1.4", "lint-staged": "^11.0.0", "node-fetch": "^2.6.1", "node-gyp": "^9.3.0", diff --git a/scripts/merge-channel-files.js b/scripts/merge-channel-files.js deleted file mode 100644 index 4b83905a9..000000000 --- a/scripts/merge-channel-files.js +++ /dev/null @@ -1,48 +0,0 @@ -// @ts-check - -// The script should be invoked with the path to a folder that contains the two files as an argument. The filenames in the folder should be: -// - stable-mac-X64.yml -// - stable-mac-ARM64.yml -// The merged file will be saved to the folder with the name stable-mac.yml and that file can then be uploaded to S3 -// The input files will be deleted if the `--no-cleanup` argument is missing. -// Usage `node ./scripts/merge-channel-files.js ./path/to/folder/with/channel/files --no-cleanup` - -const yaml = require('js-yaml'); -const fs = require('fs'); -const path = require('path'); - -const args = process.argv.slice(2) -if (args.length < 1) { - console.error('Missing channel files folder path argument.'); - process.exit(1); -} - -const [channelFilesFolder,] = args; -// 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 -if (!process.argv.includes('--no-cleanup')) { - fs.rmSync(x86ChannelFilePath); - fs.rmSync(arm64ChannelFilePath); -}