github-starred/keycastr
2
0
Fork 0
mirror of https://github.com/keycastr/keycastr.git synced 2026-05-15 14:15:50 -06:00
Code Issues 96 Projects Packages Wiki Activity Actions

Update DEVELOPING.md

Browse source
This commit is contained in:
Andrew Kitchen 2022-02-26 15:12:08 -08:00
parent 355dc2b74f
commit 6d6760f80a
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
DEVELOPING.md
View file

@ -4,16 +4,18 @@
After cloning the repository, open the project directory in a terminal or git client and run the following command: `git submodule update --init --recursive`
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 Xcode you may see a fatal error dialog or macOS Security & Privacy prompt. On macOS 10.15 and above, simply click 'Allow' and check the box next to KeyCastr in the Input Monitoring preferences pane. On macOS 10.14 or earlier, open System Preferences -> Privacy -> Accessibility, 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.
In order to run KeyCastr in the debugger the built product will need accessibility or input monitoring permissions just as the released app does. Remove any existing references to KeyCastr from the Accessibility and/or Input Monitoring sections in the Security & Privacy pane within the System Preferences.app. Locate the built product created by Xcode and drag it into the Accessibility or Input Monitoring list. Use ctrl-cmd-R in Xcode to run the same build again.
## Creating a Release
- Update app version metadata in `Info.plist` and `MainMenu.nib/keyedobjects.nib`
- Update app version metadata in `Info.plist`
- note that Sparkle uses kCFBundleVersionKey for its update version comparison, which shows up in the "Build" field in Xcode
- 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 <NEW_VERSION>' v<NEW_VERSION>`
- Commit the `Info.plist` and updated app zip and create a tag for this version, i.e. `git tag -am'Version <NEW_VERSION>' v<NEW_VERSION>`
- 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 :) )
- Create the release on GitHub from the recently pushed tag and attach the zipped copy of the app
- Update `https://keycastr.github.io/appcast.xml` using the `generate_appcast` tool bundled with Sparkle
- Update Homebrew cask using `brew bump-cask-pr` (a community member sometimes gets to it first :) )