From a8ea230fc81b21a51d7cf70eeff7a2bb282e6f6a Mon Sep 17 00:00:00 2001
From: Naveen Narayanan <naveen@gitar.co>
Date: Wed, 6 Nov 2024 17:06:22 -0800
Subject: [PATCH] [typeshare] Small fix to release script (#6)

## Description
* Small fix to force pip3 install
* Updated README pre-requisites after recent release

## Test Plan
* CI

## Revert Plan
* Revert
---
 .gitignore        |  2 +-
 scripts/README.md | 13 +++++++++++--
 scripts/build.sh  |  2 +-
 3 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/.gitignore b/.gitignore
index f97f9bbb..4c382ebf 100644
--- a/.gitignore
+++ b/.gitignore
@@ -14,6 +14,6 @@ dist/
 .idea/
 .vscode/
 
-upload.txt
+uploads.txt
 dist-manifest.json
 .intentionally-empty-file.o
diff --git a/scripts/README.md b/scripts/README.md
index fb7e6945..1f22792b 100644
--- a/scripts/README.md
+++ b/scripts/README.md
@@ -3,7 +3,7 @@
 This script is used to deploy a binary to the releases page of a GitHub repository.
 
 ## Pre-requisites
-`gh cli` must be installed and authenticated.
+1. `gh cli` must be installed and authenticated.
 
 Installation:
 ```sh
@@ -15,6 +15,15 @@ Authentication:
 gh auth login
 ```
 
+2. Make sure a release has already been created and triggered. To do this make sure to tag the commit with the version number.
+
+```sh
+git tag -a v1.12.0 -m "Release v1.12.0"
+git push origin v1.12.0
+```
+
+3. Monitor the release pipeline here: https://github.com/gitarcode/typeshare/actions/workflows/release.yml
+
 ## Usage
 
 ```sh
@@ -33,5 +42,5 @@ Options:
 ## Example
 
 ```sh
-./build.sh --version 1.12.0 --target aarch64-apple-darwin
+./build.sh --version v1.12.0 --target aarch64-apple-darwin
 ```
diff --git a/scripts/build.sh b/scripts/build.sh
index 35f28929..0b45cc12 100755
--- a/scripts/build.sh
+++ b/scripts/build.sh
@@ -63,7 +63,7 @@ if [ -z "$VERSION" ]; then
 fi
 
 # Build the project
-pip3 install ziglang
+pip3 install ziglang --break-system-packages
 cargo install cargo-zigbuild
 rustup target add "${TARGET}"
 cargo zigbuild --target "${TARGET}" --release