Skip to content

chore: v0.1.0 alpha release preparation - #20

Merged
jatinkrmalik merged 4 commits into
mainfrom
docs/fix-readme
Mar 5, 2026
Merged

chore: v0.1.0 alpha release preparation#20
jatinkrmalik merged 4 commits into
mainfrom
docs/fix-readme

Conversation

@jatinkrmalik

@jatinkrmalik jatinkrmalik commented Mar 5, 2026

Copy link
Copy Markdown
Member

v0.1.0 Alpha Release Preparation

All documentation, CI/CD, and release infrastructure needed for the first public alpha.

README Overhaul

  • Fixed truncated badge line
  • Consistent platform naming (VocaLinux / VocaMac / VocaWin) with platform icons
  • Fixed cross-platform table with proper links
  • Removed broken docs/PRD.md link
  • Added SoundManager, scripts/, web/ to project structure
  • Added Sound Effects to Configuration section
  • Added build/install/uninstall script documentation
  • Added Known Limitations section
  • Removed Roadmap section (now tracked via GitHub Issues feat: First-launch onboarding flow #22-feat: Word-level timestamps in transcription #29)
  • Replaced Author section with 'Made with ❤️ for the macOS community!'
  • Removed all em-dashes

Architecture Doc Fixes

  • Fixed duplicate SettingsView in UI layer diagram
  • Fixed bundle.sh -> build.sh reference
  • Fixed incorrect cross-platform claims (WhisperKit and CoreML are Apple-only)
  • Added SoundManager to module dependency graph

CI Improvements (ci.yml)

  • SPM dependency caching for faster builds
  • Concurrency control (cancels stale runs on same branch)
  • 30-minute timeout to prevent hung builds
  • Release build verification step
  • App bundle creation + codesign check

New Release Workflow (release.yml)

Tag-triggered automated releases:

  1. Builds release binary and .app bundle
  2. Runs full test suite
  3. Creates DMG with drag-to-Applications installer
  4. Creates ZIP archive
  5. Generates SHA-256 checksums
  6. Publishes a draft GitHub Release with all artifacts

New Release Documentation (docs/RELEASE.md)

  • Complete release checklist with testing steps
  • Versioning conventions (semver)
  • Manual release instructions (without CI)
  • Hotfix process
  • Code signing roadmap

After Merging

git tag -a v0.1.0 -m "VocaMac v0.1.0 - Alpha Release"
git push origin v0.1.0

Then review and publish the draft release on GitHub.

- Remove broken link to deleted PRD.md
- Add SoundManager.swift to project structure
- Add scripts/ directory (build.sh, install.sh, uninstall.sh)
- Add web/ directory to project structure
- Add build scripts and uninstall instructions to Build Commands
- Add Known Limitations section (ad-hoc signing, first launch, macOS only)
- Mark audio feedback sounds as completed in roadmap
- Add Twitter/X link to author section
Replaced 46 em-dashes with spaced hyphens for cleaner readability.
README:
- Fix truncated badge line
- Consistent platform naming (VocaLinux/VocaMac/VocaWin) with platform icons
- Fix cross-platform table consistency and links
- Remove broken PRD.md link
- Add SoundManager, scripts/, web/ to project structure
- Add Sound Effects to Configuration section
- Add build/install/uninstall script docs
- Add Known Limitations section
- Remove Roadmap (tracked via GitHub Issues now)
- Replace Author section with community footer
- Remove all em-dashes

ARCHITECTURE.md:
- Fix duplicate SettingsView in UI layer diagram
- Fix bundle.sh -> build.sh reference
- Fix incorrect cross-platform claims (WhisperKit/CoreML are Apple-only)
- Add SoundManager to module dependency graph
- Remove all em-dashes
CI improvements:
- Add SPM dependency caching for faster builds
- Add concurrency control (cancel in-progress runs)
- Add 30-minute timeout
- Add release build verification step
- Add app bundle creation and codesign verification

New release workflow (release.yml):
- Triggered by version tags (v*)
- Builds release binary and .app bundle
- Creates DMG with drag-to-Applications installer
- Creates ZIP archive
- Generates SHA-256 checksums
- Publishes draft GitHub Release with all artifacts

New docs/RELEASE.md:
- Complete release process documentation
- Version checklist and testing steps
- CI workflow descriptions
- Manual release instructions
- Hotfix process
- Code signing roadmap
@jatinkrmalik jatinkrmalik changed the title docs: fix README for v0.1.0 alpha release chore: v0.1.0 alpha release preparation Mar 5, 2026
@jatinkrmalik
jatinkrmalik merged commit 0362fcf into main Mar 5, 2026
1 check passed
@jatinkrmalik
jatinkrmalik deleted the docs/fix-readme branch August 22, 2026 05:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant