diff --git a/src/server_manager/README.md b/src/server_manager/README.md index a3d940bf..38eebfb5 100644 --- a/src/server_manager/README.md +++ b/src/server_manager/README.md @@ -39,10 +39,10 @@ This will enable the Developer menu on the application window. To build the app binary: ``` -npm run action server_manager/electron_app/package_${PLATFORM} +npm run action server_manager/electron_app/build ${PLATFORM} -- --buildMode=[debug,release] ``` -Where `${PLATFORM}` is one of `linux`, `macos`, `only_windows`. +Where `${PLATFORM}` is one of `linux`, `mac`, `windows`. The per-platform standalone apps will be at `build/electron_app/static/dist`. @@ -50,15 +50,6 @@ The per-platform standalone apps will be at `build/electron_app/static/dist`. - Linux: tar.gz files. - macOS: dmg files if built from macOS, zip files otherwise. -## Releases - -To perform a release, use -``` -npm run action server_manager/electron_app/release -``` - -This will perform a clean and reinstall all dependencies to make sure the build is not tainted. - ## Error reporting To enable error reporting through [Sentry](https://sentry.io/) for local builds, run: @@ -67,4 +58,10 @@ export SENTRY_DSN=[Sentry development API key] npm run action server_manager/electron_app/start ``` -Release builds on CI are configured with a production Sentry API key. +## CI Environment Variables + +For your CI to run smoothly, you'll need the following in your ENV: + +- `SENTRY_DSN` - [url required](https://docs.sentry.io/product/sentry-basics/dsn-explainer/) to enable sentry integration. Same across all platforms. +- `RELEASES_REPOSITORY` - the username and repository name of the repository you're pushing releases to. In our case, `Jigsaw-Code/outline-releases` +- `RELEASES_DEPLOY_KEY` - an ssh secret key for the matching releases repository public deploy key - [how to set this up](https://docs.github.com/en/developers/overview/managing-deploy-keys#setup-2)