Skip to content

ci: add macOS DMG and Windows installer to release artifacts#114

Merged
iamvirul merged 4 commits into
mainfrom
feature/macos-dmg-release
May 3, 2026
Merged

ci: add macOS DMG and Windows installer to release artifacts#114
iamvirul merged 4 commits into
mainfrom
feature/macos-dmg-release

Conversation

@iamvirul

@iamvirul iamvirul commented May 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a macos-dmg job to the release workflow that runs on macos-latest after GoReleaser completes
  • Adds a windows-installer job to the release workflow that runs on windows-latest after GoReleaser completes
  • Both jobs are gated on needs: goreleaser so the release exists before artifact upload

macOS DMG

Builds darwin/amd64 and darwin/arm64 binaries natively (both in parallel via matrix). Packages each binary into a compressed DMG using hdiutil (built-in macOS, zero extra dependencies) alongside README.md, deepdiffdb.config.yaml.example, and an install.sh helper.

deepdiff-db-v1.4.x-darwin-amd64.dmg
deepdiff-db-v1.4.x-darwin-arm64.dmg

Each DMG contains deepdiffdb, README.md, deepdiffdb.config.yaml.example, and install.sh (copies binary to /usr/local/bin).

Why hdiutil: built into every macOS runner — no brew install, no flaky installs.

Windows Installer

Builds a windows/amd64 binary then compiles a proper NSIS installer (makensis). The installer template lives at .github/windows-installer.nsi with an __APP_VERSION__ placeholder substituted by sed at build time.

deepdiff-db-v1.4.x-windows-amd64-installer.exe

The installer:

  • Installs deepdiffdb.exe to %ProgramFiles%\DeepDiffDB
  • Adds the install directory to the system PATH (with duplicate-check and live broadcast so no reboot required)
  • Registers in Add/Remove Programs with display name, version, publisher, homepage
  • Ships a full Uninstaller that removes the binary, cleans the PATH entry, and removes registry keys
  • Self-contained NSIS script — no external plugins required

Test plan

  • Push a v* tag and verify all four artifacts appear in the release:
    • deepdiff-db-vX.Y.Z-darwin-amd64.dmg
    • deepdiff-db-vX.Y.Z-darwin-arm64.dmg
    • deepdiff-db-vX.Y.Z-windows-amd64-installer.exe
  • Mount DMG on macOS, run install.sh, confirm binary works
  • Run Windows installer, confirm deepdiffdb is on PATH after install
  • Run Windows uninstaller, confirm PATH is cleaned up

Adds a macos-dmg job that runs on macos-latest after GoReleaser
completes. Builds both darwin/amd64 and darwin/arm64 binaries natively,
packages them into a compressed DMG (hdiutil, no external dependencies)
alongside README, config example, and an install.sh helper, then
uploads them to the GitHub release with gh release upload.
@coderabbitai

coderabbitai Bot commented May 3, 2026

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@iamvirul has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 27 minutes and 3 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 11da3e64-eac1-410e-9a42-4dee78097f36

📥 Commits

Reviewing files that changed from the base of the PR and between 90391e9 and 7846906.

📒 Files selected for processing (3)
  • .github/windows-installer.nsi
  • .github/workflows/release.yml
  • CHANGELOG.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/macos-dmg-release

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 0/1 reviews remaining, refill in 27 minutes and 3 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov

codecov Bot commented May 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@iamvirul iamvirul self-assigned this May 3, 2026
- Add .github/windows-installer.nsi — a self-contained NSIS script with
  StrContains/StrReplaceAll helpers (no external plugins required).
  Installs deepdiffdb.exe to %ProgramFiles%\DeepDiffDB, appends to the
  system PATH (idempotent), registers in Add/Remove Programs, and ships
  a proper uninstaller that cleans the PATH entry on removal.
- Workflow: windows-installer job on windows-latest, needs goreleaser.
  Builds windows/amd64 binary with Go, runs choco install nsis, subs
  __APP_VERSION__ placeholder with sed, compiles with makensis, uploads
  deepdiff-db-vX.Y.Z-windows-amd64-installer.exe to the release.
@iamvirul iamvirul changed the title ci: add macOS DMG build for release artifacts ci: add macOS DMG and Windows installer to release artifacts May 3, 2026
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 3, 2026
@iamvirul iamvirul merged commit 3fae47d into main May 3, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation github-actions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant