Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-22 20:53:19 +00:00
Code Issues Projects Releases Packages Wiki Activity
ratatui/RELEASE.md
Josh McKinney 593fd29d00
chore(demo): update demo gif with a fixed unicode gauge (#227) 
* fix(gauge): render gauge with unicode correctly

Gauge now correctly renders a block rather than a space when in unicode mode.

* docs: update demo.gif

- remove existing gif
- upload using VHS (https://github.com/charmbracelet/vhs)
- add instructions to RELEASE.md
- link new gif in README
2023-06-11 16:23:23 +02:00

1.4 KiB
Raw Blame History

Creating a Release

crates.io releases are automated via GitHub actions and triggered by pushing a tag.

  1. Record a new demo gif. I found the best tool for this was ttyrec and ttygif. Asciinema handles block character height poorly, termanilizer takes forever to render, vhs handles braille characters poorly (though if https://github.com/charmbracelet/vhs/issues/322 is fixed, then it's probably the best option).

    cargo build --example demo
ttyrec -e 'cargo --quiet run --release --example demo -- --tick-rate 100' demo.rec
ttygif demo.rec

    Then upload it somewhere (e.g. use vhs publish tty.gif to publish it or upload it to a github wiki page as an attachment). Avoid adding the gif to the git repo as binary files tend to bloat repositories.

  2. Bump the version in Cargo.toml.

  3. Ensure CHANGELOG.md is updated. git-cliff can be used for generating the entries.

  4. Commit and push the changes.

  5. Create a new tag: git tag -a v[X.Y.Z]

  6. Push the tag: git push --tags

  7. Wait for Continuous Deployment workflow to finish.