diff --git a/.changeset/upset-clubs-yawn.md b/.changeset/upset-clubs-yawn.md new file mode 100644 index 00000000..c76dfefc --- /dev/null +++ b/.changeset/upset-clubs-yawn.md @@ -0,0 +1,5 @@ +--- +"kiji-privacy-proxy": patch +--- + +Fixed homebrew release diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 79e8d2d2..1d21f475 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -127,7 +127,12 @@ jobs: ### macOS Installation - **Quick Start:** + **Homebrew (recommended):** + ```bash + brew install --cask dataiku/tap/kiji-privacy-proxy + ``` + + **Or download manually:** 1. Download `Kiji-Privacy-Proxy-${{ steps.version.outputs.version }}.dmg` 2. Open the DMG and drag to Applications 3. Launch "Kiji Privacy Proxy" @@ -396,11 +401,16 @@ jobs: git config user.name "${APP_SLUG}[bot]" git config user.email "${APP_SLUG}[bot]@users.noreply.github.com" - if git diff --quiet -- Casks/kiji-privacy-proxy.rb; then + # Stage first, then compare the index against HEAD. `git diff --quiet + # -- ` ignores untracked files, so on the first publish (when + # the cask does not yet exist in the tap) it would wrongly report + # "nothing to commit" and never push. `git diff --cached --quiet` + # detects both brand-new and modified files. + git add Casks/kiji-privacy-proxy.rb + if git diff --cached --quiet; then echo "::notice::Cask already at ${VERSION}, nothing to commit." exit 0 fi - git add Casks/kiji-privacy-proxy.rb git commit -m "kiji-privacy-proxy ${VERSION}" git push origin HEAD:main diff --git a/README.md b/README.md index 58433237..36eec053 100644 --- a/README.md +++ b/README.md @@ -65,11 +65,16 @@ When using AI services like OpenAI or Anthropic, sensitive data in your prompts ### For Users **macOS (Desktop App):** + +Homebrew (recommended): ```bash -# Download from releases -# https://github.com/dataiku/kiji-proxy/releases +brew install --cask dataiku/tap/kiji-privacy-proxy +``` -# Install +Or download manually: +```bash +# Download the latest DMG from +# https://github.com/dataiku/kiji-proxy/releases open Kiji-Privacy-Proxy-*.dmg # Drag to Applications folder ``` diff --git a/docs/01-getting-started.md b/docs/01-getting-started.md index 673a4e26..1e3e3518 100644 --- a/docs/01-getting-started.md +++ b/docs/01-getting-started.md @@ -55,6 +55,16 @@ The backend supports two proxy modes that can run simultaneously: ### macOS (Desktop App) +**Homebrew (recommended):** + +```bash +brew install --cask dataiku/tap/kiji-privacy-proxy +``` + +Upgrade later with `brew upgrade --cask kiji-privacy-proxy`. + +**Manual download:** + 1. Download the latest DMG from [Releases](https://github.com/dataiku/kiji-proxy/releases) 2. Open the DMG file 3. Drag "Kiji Privacy Proxy" to Applications