RELEASE.md

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 demo2
   vhs examples/demo2.tape

2. Switch branches to the images branch and copy demo2.gif to examples/, commit, and push.

3. Grab the permalink from https://github.com/ratatui-org/ratatui/blob/images/examples/demo2.gif and append ?raw=true to redirect to the actual image url. Then update the link in the main README. Avoid adding the gif to the git repo as binary files tend to bloat repositories.

4. Bump the version in Cargo.toml.

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

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

7. Ensure that any breaking changes are documented in BREAKING-CHANGES.md

8. Commit and push the changes.

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

10. Push the tag: git push --tags

11. Wait for Continuous Deployment workflow to finish.