Skip to content

Commit 2e71c5e

Browse files
committed
Remove demo regeneration from release script
Regenerate manually, as it's a slow process and unnecessary to do for each release
1 parent a34e01d commit 2e71c5e

5 files changed

Lines changed: 17 additions & 8 deletions

File tree

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -163,18 +163,27 @@ act -j test --matrix os:ubuntu-latest --container-architecture linux/amd64
163163

164164
## Demo
165165

166-
The demo GIF is generated with [VHS](https://github.com/charmbracelet/vhs). To regenerate it:
166+
The demo GIFs are generated with [VHS](https://github.com/charmbracelet/vhs). To regenerate them:
167167

168168
```bash
169169
brew install vhs
170-
vhs ./demo/demo.tape
170+
vhs ./demo/demo-latte.tape
171+
vhs ./demo/demo-mocha.tape
171172
```
172173

173-
This outputs `demo.gif` from the tape file.
174+
Or:
175+
176+
```bash
177+
vhs demo/demo-latte.tape & vhs demo/demo-mocha.tape & wait
178+
```
179+
180+
These output GIFs in `./demo/`.
174181

175182
## Website
176183

177-
See `website/README.md` for instructions on running the demo website at https://hdi.md
184+
See `website/README.md` for instructions on running the demo website locally.
185+
186+
It is deployed to https://hdi.md via GitHub Pages on every release.
178187

179188
## Benchmarking
180189

demo/demo-latte.gif

50.7 KB
Loading

demo/demo-mocha.gif

52.8 KB
Loading

release

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,6 @@ sed -i.bak "s/^VERSION=\"$current\"/VERSION=\"$new\"/" "$SRC_HEADER" && rm -f "$
6666
# Rebuild hdi from source
6767
"$SCRIPT_DIR/build"
6868

69-
# Regenerate demo GIFs
70-
vhs "$SCRIPT_DIR/demo/demo-latte.tape"
71-
vhs "$SCRIPT_DIR/demo/demo-mocha.tape"
72-
7369
# Run benchmarks against the new version
7470
if [[ -x "$SCRIPT_DIR/bench/run" ]]; then
7571
echo ""

website/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,3 +107,7 @@ npm run astro -- --help
107107
```bash
108108
./prepare-website.sh
109109
```
110+
111+
## Deployment
112+
113+
Deployment to GitHub Pages is automatic on every release via the `pages.yml` GitHub Actions workflow. It can also be triggered manually by running the workflow from the [Actions tab in GitHub](https://github.com/grega/hdi/actions).

0 commit comments

Comments
 (0)