From 53e7e24c5a9f9ec3dfe121b7b1d1c1aad62816e4 Mon Sep 17 00:00:00 2001 From: Andrew Kitchen Date: Fri, 1 Nov 2019 16:00:26 -0700 Subject: [PATCH] Added DEVELOPING.md with some helpful tips & reminders --- DEVELOPING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 DEVELOPING.md diff --git a/DEVELOPING.md b/DEVELOPING.md new file mode 100644 index 0000000..8af877f --- /dev/null +++ b/DEVELOPING.md @@ -0,0 +1,17 @@ +# Developer's notes + +## Running and Debugging + +In order to run KeyCastr in the debugger, the built product needs accessibility permissions just as the released app does. Upon first launching a new build in the debugger you may see a fatal error dialog -- if so, open System Preferences -> Privacy -> Accessibility (or Input Monitoring on macOS 10.15 and above), right click on KeyCastr.app under Built Products in the Xcode project navigator and select 'Show in Finder', and drag KeyCastr.app from the Build/Products folder into the Accessibility list. In Xcode, ctrl-cmd-R to run the same build again. + +## Creating a Release + - Update app version metadata in `Info.plist` and `MainMenu.nib/keyedobjects.nib` + - Developer ID must be set up for code signing and notarization + - Archive the app and follow Apple's instructions for uploading a release to be notarized + - Upon receiving the success notification from Apple, export the notarized build from the project + - Verify exported artifact is notarized (w/ shell command) + - Update the zip file in the `bin/` folder to contain the new .app build + - Create a tag for this version, i.e. `git tag -am'Version ' v` + - Push the commits and tags with `git push origin head && git push --tags` + - Update `https://keycastr.github.io/appcast.xml` with tools bundled with Sparkle + - Update brew-cask (a community member sometimes gets to it first :) )