Skip to content

Commit b4f7ca2

Browse files
[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
1 parent aadd8dc commit b4f7ca2

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ dist/
1414
.idea/
1515
.vscode/
1616

17-
upload.txt
17+
uploads.txt
1818
dist-manifest.json
1919
.intentionally-empty-file.o

scripts/README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This script is used to deploy a binary to the releases page of a GitHub repository.
44

55
## Pre-requisites
6-
`gh cli` must be installed and authenticated.
6+
1. `gh cli` must be installed and authenticated.
77

88
Installation:
99
```sh
@@ -15,6 +15,15 @@ Authentication:
1515
gh auth login
1616
```
1717

18+
2. Make sure a release has already been created and triggered. To do this make sure to tag the commit with the version number.
19+
20+
```sh
21+
git tag -a v1.12.0 -m "Release v1.12.0"
22+
git push origin v1.12.0
23+
```
24+
25+
3. Monitor the release pipeline here: https://github.com/gitarcode/typeshare/actions/workflows/release.yml
26+
1827
## Usage
1928

2029
```sh
@@ -33,5 +42,5 @@ Options:
3342
## Example
3443

3544
```sh
36-
./build.sh --version 1.12.0 --target aarch64-apple-darwin
45+
./build.sh --version v1.12.0 --target aarch64-apple-darwin
3746
```

scripts/build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ if [ -z "$VERSION" ]; then
6363
fi
6464

6565
# Build the project
66-
pip3 install ziglang
66+
pip3 install ziglang --break-system-packages
6767
cargo install cargo-zigbuild
6868
rustup target add "${TARGET}"
6969
cargo zigbuild --target "${TARGET}" --release

0 commit comments

Comments
 (0)