Skip to content

Commit 4c0046b

Browse files
authored
Document release process (#969)
1 parent 0f00041 commit 4c0046b

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

RELEASE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# How to release new versions
2+
3+
1. If there are Rust changes, update `icechunk/Cargo.toml` increasing version.
4+
1. Update `icechunk-python/Cargo.toml` increasing version. This version can be ahead of the one in `icechunk/Cargo.toml`, that's OK.
5+
1. If there are Rust changes, update the version on the dependency on Rust Icechunk library in `icechunk-python/Cargo.toml`.
6+
1. Run tests to ensure `Cargo.lock` updates and everything works.
7+
1. Document changes in `Changelog.md` and commit.
8+
1. Prepare the desired release on a branch or tag (not the official tag name, this ref can be temporary). We usually use `main` for the release point.
9+
1. Run the [`publish rust library`](https://github.com/earth-mover/icechunk/actions/workflows/publish-rust-library.yml) workflow on the ref you want to release.
10+
1. After the previous point completes, run the [`Python CI and library release`](https://github.com/earth-mover/icechunk/actions/workflows/python-ci.yaml) workflow on the ref you want to release.
11+
1. After the previous point completes, [create a new release in GitHub](https://github.com/earth-mover/icechunk/releases/new). Ask it to create the tag, and generate the release notes. This step will notify the community slack of the new release.

0 commit comments

Comments
 (0)