Mirrors/ratatui
2
0
Fork 0
mirror of https://github.com/ratatui-org/ratatui synced 2024-11-22 04:33:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
ratatui/RELEASE.md
Josh McKinney 8c55158822
chore: use vhs to create demo.gif (#390) 
The bug that prevented braille rendering is fixed, so switch to VHS for
rendering the demo gif

![Demo of Ratatui](https://vhs.charm.sh/vhs-tF0QbuPbtHgUeG0sTVgFr.gif)
2023-08-13 16:21:00 +00:00

1 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 if necessary. The preferred tool for this is vhs (installation instructions in README).

    cargo build --example demo
vhs examples/demo.tape --publish --quiet

    Then update the link in the examples README and the main README. Avoid adding the gif to the git repo as binary files tend to bloat repositories.

  2. Bump the version in Cargo.toml.

  3. Bump versions in the doc comments of lib.rs.

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

  5. Commit and push the changes.

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

  7. Push the tag: git push --tags

  8. Wait for Continuous Deployment workflow to finish.