docs+ci: SHIPPING_MAC.md + VOICE_INPUT.md + release pipeline ready for activation#53
Merged
Merged
Conversation
…vation
Two long-form docs + release workflow polish.
· docs/SHIPPING_MAC.md (NEW, ~140 lines)
- Prereqs: Apple Developer membership, Xcode, Developer ID Application
cert, app-specific password, GH PAT.
- One-time CI secrets table (APPLE_ID / APPLE_APP_SPECIFIC_PASSWORD /
APPLE_TEAM_ID / CSC_LINK / CSC_KEY_PASSWORD / GH_TOKEN).
- First local build commands (install heavy deps → activate
.template configs → dev → pack → dist).
- Releasing via tag flow.
- Sanity-check notarytool history + spctl verification.
- Auto-update flow walkthrough.
- Common failure modes (cert without private key, notarytool
stuck in progress, spctl rejection, quarantine flag).
· docs/VOICE_INPUT.md (NEW, ~120 lines)
- whisper.cpp install: macOS Homebrew + Linux source build.
- Model download (base.en recommended; sizes vs accuracy).
- settings.json `voice` config.
- CLI + Mac client usage flow.
- Privacy notes (audio file deleted post-transcript, no network).
- Troubleshooting.
- API example for plugin authors using @deepcode/core's
WhisperCppProvider directly.
· .github/workflows/release.yml
- build-mac job: `if: false` → `if: vars.BUILD_MAC == 'true'`. The
maintainer flips a Repository Variable when Apple secrets are
wired; everything else stays automatic.
- build-mac now activates the .template configs before building,
and runs build:renderer + build:electron before electron-builder.
- github-release: replaced the hand-rolled `git log` snippet with
`npx tsx scripts/gen-release-notes.ts <prev-tag> HEAD` — uses
the conventional-commit bucketing from PR #47.
Tests: still 512 passing. Nothing changes at runtime; this PR is docs +
config only.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two long-form docs and release workflow polish. SHIPPING_MAC.md covers Apple Developer ID + notarization + auto-update flow + troubleshooting (~140 lines). VOICE_INPUT.md covers whisper.cpp install on macOS/Linux + model download + settings + privacy + plugin API. release.yml: build-mac gate flipped to vars.BUILD_MAC == 'true' (maintainer enables via Repo Variables) + activates .template configs + uses gen-release-notes.ts. 512 tests still passing.