Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ All significant changes to this project will be documented in this file.
* `CountMinSketch` now has a type parameter for the count type. Possible values are `u8` to `u64` and `i8` to `i64`.
* `HllUnion::get_result` is renamed to `HllUnion::to_sketch`.
* `update_f32` and `update_f64` are removed from `ThetaSketch`. Use `hash_value`'s wrapper instead.
* All sketches are now gated by a feature flag. You need to enable the feature flag to use the sketch. For example, to use `CountMinSketch`, you need to enable the `countmin` feature.

### Notable changes

* The MSRV (Minimum Supported Rust Version) is now 1.86.0.

### New features

Expand Down
28 changes: 14 additions & 14 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ CI validates every commit and ensures:
```bash
# Simply tag the current commit as RC
git checkout main
git tag -a 0.3.0-RC1 -m "Release candidate 1 for 0.3.0"
git push origin 0.3.0-RC1
git tag -a 0.3.0-rc.1 -m "Release candidate 1 for 0.3.0"
git push origin 0.3.0-rc.1
```

## Step 2: Publish Release Candidate to crates.io
Expand Down Expand Up @@ -86,15 +86,15 @@ cd ~/apache/dist/dev/datasketches/scripts
./bashDeployToDist.sh \
/path/to/datasketches-rust \
datasketches-rust \
0.3.0-RC1
0.3.0-rc.1
```

This script will:

1. Create a source archive from the git tag
2. Generate GPG signature (`.asc`)
3. Generate SHA512 checksum (`.sha512`)
4. Upload to https://dist.apache.org/repos/dist/dev/datasketches/rust/0.3.0-RC1/
4. Upload to https://dist.apache.org/repos/dist/dev/datasketches/rust/0.3.0-rc.1/

Verify the files are accessible at the URL above.

Expand All @@ -112,19 +112,19 @@ Hi everyone,
I propose releasing Apache DataSketches Rust version 0.3.0.

Source distribution:
https://dist.apache.org/repos/dist/dev/datasketches/rust/0.3.0-RC1/
https://dist.apache.org/repos/dist/dev/datasketches/rust/0.3.0-rc.1/

GitHub tag:
https://github.com/apache/datasketches-rust/releases/tag/0.3.0-RC1
https://github.com/apache/datasketches-rust/releases/tag/0.3.0-rc.1
Comment thread
tisonkun marked this conversation as resolved.

Testing (choose one or both):
- crates.io RC: cargo add datasketches@0.3.0-rc.1
- From source: Download, verify signatures, cargo x test

To verify signatures:
curl -O https://dist.apache.org/repos/dist/dev/datasketches/rust/0.3.0-RC1/datasketches-rust-0.3.0-RC1-src
curl -O https://dist.apache.org/repos/dist/dev/datasketches/rust/0.3.0-RC1/datasketches-rust-0.3.0-RC1-src.asc
gpg --verify datasketches-rust-0.3.0-RC1-src.asc
curl -O https://dist.apache.org/repos/dist/dev/datasketches/rust/0.3.0-rc.1/datasketches-rust-0.3.0-rc.1-src
curl -O https://dist.apache.org/repos/dist/dev/datasketches/rust/0.3.0-rc.1/datasketches-rust-0.3.0-rc.1-src.asc
gpg --verify datasketches-rust-0.3.0-rc.1-src.asc

Notable changes: [link to CHANGELOG or summary]

Expand All @@ -141,9 +141,9 @@ Vote will remain open for at least 72 hours.

```bash
# Fix the issues, commit to main, then tag the new RC
git tag -a 0.3.0-RC2 -m "Release candidate 2 for 0.3.0"
git push origin 0.3.0-RC2
# Then repeat from Step 2 (with version 0.3.0-RC2)
git tag -a 0.3.0-rc.2 -m "Release candidate 2 for 0.3.0"
git push origin 0.3.0-rc.2
# Then repeat from Step 2 (with version 0.3.0-rc.2)
```

## Step 5: Close Vote & Publish Release
Expand All @@ -153,7 +153,7 @@ After successful vote, send [VOTE-RESULT] email summarizing the outcome and proc
```bash
# Move artifacts from dev to release
cd ~/apache/dist/dev/datasketches/scripts
./moveDevToRelease.sh rust 0.3.0-RC1 0.3.0
./moveDevToRelease.sh rust 0.3.0-rc.1 0.3.0

# Update Cargo.toml to final release version (this is the only version commit!)
cd /path/to/datasketches-rust
Expand Down Expand Up @@ -202,7 +202,7 @@ Go to https://github.com/apache/datasketches-rust/releases and draft a new relea
**Need to yank a crate?**

```bash
cargo yank --vers 0.3.0-RC1 datasketches
cargo yank --vers 0.3.0-rc.1 datasketches
```

Only for broken pre-releases. For released versions, publish a patch instead.
Expand Down