Skip to content

Commit

Permalink
[typeshare] Small fix to release script (#6)
Browse files Browse the repository at this point in the history
## Description
* Small fix to force pip3 install
* Updated README pre-requisites after recent release

## Test Plan
* CI

## Revert Plan
* Revert
  • Loading branch information
naveenOnarayanan authored Nov 7, 2024
1 parent 8a48ead commit a8ea230
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@ dist/
.idea/
.vscode/

upload.txt
uploads.txt
dist-manifest.json
.intentionally-empty-file.o
13 changes: 11 additions & 2 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
```
2 changes: 1 addition & 1 deletion scripts/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a8ea230

Please sign in to comment.