You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: dev-docs/04-versioning-and-deployment.md
+21-11
Original file line number
Diff line number
Diff line change
@@ -45,18 +45,28 @@ builds of `packages/desktop`, prepare a draft Github release, and upload the bui
45
45
6) [Update the GitHub release](https://github.com/AllenInstitute/biofile-finder/releases) once the Github action in Step 4 is finished, manually edit the Github release which was drafted as part of Step 4. Format its release name with the date (consistent with other release names), add a description of the changes, and optionally
46
46
mark whether the release is "pre-release." If it is marked as "pre-release," it will not be accessible for download through the
47
47
Github pages site.
48
-
<!-- Added by Anya W 2025-01-07 -->
49
-
7) **Temporary workaround for MacOS** (as of Jan 2025): GitHub Actions currently builds .dmg files that don't work for x86 processors and that are interpreted as "damaged" by new MacOS versions. To get around this, follow the instructions below to [manually build executables](#manually-building-an-executable). You will need to do this separately for both arm64 and x86, and each build process **must be done on a machine that uses the correct processor** (e.g., on a computer with an Intel chip for the x86 build).
50
-
51
-
After building, change the .dmg name to match the current tag number and the processor that the build is for (e.g., `BioFile Finder-tag.number-arm64.dmg` or `BioFile Finder-tag.number-x86_64.dmg`), and upload these to the release page. You may need to delete existing .dmg files from the release if GitHub has already generated them automatically.
52
48
53
-
If the build doesn't work (e.g., says it's damaged when downloaded from GitHub), change the `mac` build arch in `/desktop/package.json` from `"universal"` to whichever processor you're targeting (e.g., `"arm64"`).
49
+
<!-- Added by Brian W 2025-02-18 -->
50
+
7) **Temporary workaround for MacOS Intel Chipsets (as of Feb 2025):**
51
+
GitHub Actions currently builds .dmg files that don't work for x86 processors and that are interpreted as "damaged" by new MacOS versions. The primary recommendation for building executables for Intel chipsets on MacOS is now to use the [manual-build](https://github.com/AllenInstitute/biofile-finder/actions/workflows/manual-build.yml) GitHub Action. This workflow automatically generates .dmg files for x86 architectures. To build the x86 version, ensure that you select the macOS-13 runner environment in the workflow, which is configured specifically for x86 builds. After the workflow completes, download, unzip and rename the .dmg file to include the current tag number and the target processor.
54
52
55
-
## Manually building an executable
56
-
To manually build an executable for the desktop app, run the following from inside the `packages/desktop` directory:
53
+
If additional customization is needed or if you encounter issues with the workflow, you can use the fallback option locally:
54
+
<!-- Added by Anya W 2025-01-07 -->
55
+
Navigate to the `packages/desktop` directory and run:
56
+
```
57
+
npm run build-executable
58
+
```
59
+
This command creates a build directory containing an install file (e.g., BioFile Finder-tag.number.dmg). After the build completes, rename the .dmg file to include the current tag number and the target processor (for example, BioFile Finder-tag.number-arm64.dmg or BioFile Finder-tag.number-x86_64.dmg), and upload the file to the release page. If GitHub has already generated .dmg files automatically, you may need to delete them before uploading your build.
60
+
61
+
62
+
63
+
### Development Builds for Specific Branches
64
+
65
+
You can generate development builds from any branch using the [manual-build](https://github.com/AllenInstitute/biofile-finder/actions/workflows/manual-build.yml) GitHub Action. Select the branch from the dropdown in the GitHub Action interface and choose the appropriate runner environment from the following options:
57
66
```
58
-
npm run build-executable
67
+
ubuntu-latest for Linux builds
68
+
windows-latest for Windows builds
69
+
macOS-latest for ARM builds
70
+
macOS-13 for x86 builds
59
71
```
60
-
This will create a `build` directory in`packages/desktop`, where it will package the app based on your current branch. The directory will contain an install file (e.g., `BioFile Finder-tag.number.dmg`if built on a Mac).
61
-
62
-
If needed, this install file can be manually added to a GitHub release. Note that this is currently necessary in order to release BFF for Macs that use Intel chips, since the GitHub workflow only generates working executables for ARM processors (Apple Silicon chips).
72
+
Once you trigger the workflow, the process will generate a zipped artifact containing all the build artifacts. Download this artifact from the workflow, unzip it to access the build. Please note that these zipped artifacts are available for 7 days after which they are automatically deleted.
0 commit comments