-
Notifications
You must be signed in to change notification settings - Fork 2k
Open
Description
Release process
- copy this checklist to a new egui issue, called "Release 0.xx.y"
- close all issues in the milestone for this release
Optional polish before a major release
- improve the demo a bit
- see if you can make web demo WASM smaller
-
./scripts/docs.sh: read and improve documentation of new stuff -
cargo update -
cargo outdated(or manually look for outdated crates in eachCargo.toml)
Release testing
-
cargo r -p egui_demo_appand click around for while - update
eframe_templateand test - update
egui_plotand test - update
egui_tableand test - update
egui_tilesand test - test with Rerun
-
./scripts/check.sh - check that CI is green
Preparation
- make sure there are no important unmerged PRs
- Ensure we don't have any patch/git dependencies (e.g. kittest)
- Create a branch called
release-0.xx.0and open a PR for it - run
scripts/generate_example_screenshots.shif needed - write a short release note that fits in a bluesky post
- record gif for
CHANGELOG.mdrelease note (and later bluesky post) - update changelogs
- run
scripts/generate_changelog.py --version 0.x.0 --write - read changelogs and clean them up if needed
- write a good intro with highlight for the main changelog
- run
- run
typos
Actual release
- bump version numbers in workspace
Cargo.toml - check that CI for the PR is green
- publish the crates by running
scripts/publish_crates.sh -
git tag -a 0.x.0 -m 'Release 0.x.0 - <release title>' -
git pull --tags ; git tag -d latest && git tag -a latest -m 'Latest release' && git push --tags origin latest --force ; git push --tags - merge release PR as
Release 0.x.0 - <release title> - check that CI for
mainis green - do a GitHub release: https://github.com/emilk/egui/releases/new
- follow the format of the last release
- wait for the documentation build to finish: https://docs.rs/releases/queue
- https://docs.rs/egui/ works
- https://docs.rs/eframe/ works
Announcements
- Bluesky
- egui discord
- r/rust
- r/programming
- This Week in Rust
After release
- update
eframe_template - publish new
egui_plot - publish new
egui_table - publish new
egui_tiles - make a PR to
egui_commonmark - make a PR to
rerun
Finally
- close the milestone
- close this issue
- improve
RELEASES.mdwith what you learned this time around
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels