Merge branch 'main' of github.com:AllenInstitute/biofile-finder into …

…feature/metadata-editing/develop

.github/workflows/aws-deployment.yml

@@ -37,7 +37,7 @@ jobs:
 
       - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Install Dependencies
         run: npm ci

.github/workflows/integration.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@main
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Install Dependencies
         run: npm ci
@@ -42,7 +42,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@main
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Install Dependencies
         run: npm ci
@@ -60,7 +60,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@main
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Install Dependencies
         run: npm ci
@@ -78,7 +78,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@main
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Install Dependencies
         run: npm ci
@@ -100,7 +100,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@main
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Build Electron app
         uses: AllenCellSoftware/action-electron-builder@fms-file-explorer

.github/workflows/release.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Install Node.js
         uses: actions/setup-node@main
         with:
-          node-version: 16
+          node-version: 18
 
       - name: Build/release Electron app
         uses: AllenCellSoftware/action-electron-builder@fms-file-explorer

dev-docs/02-setup-and-workflow.md

@@ -12,8 +12,8 @@ To help with the management of three interconnected packages, this project makes
 
 
 ### System requirements
-1. NodeJS version 16.x (use `nvm` or similar)
-2. NPM version 8.x
+1. NodeJS version 18.x (use `nvm` or similar)
+2. NPM version 10.x
 
 
 ### Initial setup

dev-docs/04-versioning-and-deployment.md

@@ -39,8 +39,18 @@ The following captures the steps of a release of this project to desktop:
     ```bash
     npm --no-commit-hooks version --workspace packages/desktop $VERSION_BUMP_TYPE -m "v%s"
     ```
+    Verify that the `"version"` property in all `package.json` files matches the new version number; otherwise, update them to match. 
 5) Wait for a [GitHub Action](https://github.com/AllenInstitute/biofile-finder/actions) to automatically create new platform-specific
 builds of `packages/desktop`, prepare a draft Github release, and upload the builds as release artifacts to that release.
 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
 mark whether the release is "pre-release." If it is marked as "pre-release," it will not be accessible for download through the
 Github pages site.
+
+### Manually building an executable
+To manually build an executable for the desktop app, run the following from inside the `packages/desktop` directory:
+```
+npm run build-executable
+```
+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). 
+
+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).