Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation for releasing new rust core #2987

Open
ctb opened this issue Feb 10, 2024 · 7 comments
Open

add documentation for releasing new rust core #2987

ctb opened this issue Feb 10, 2024 · 7 comments
Labels
doc documentation content or issues

Comments

@ctb
Copy link
Contributor

ctb commented Feb 10, 2024

what I did for r0.12.1, based on r0.12.0

# generate log of PRs
git log --oneline r0.12.0..latest src/core | cut -d\  -f2- > /tmp/out.txt

#edited src/core/CHANGELOG.md appropriately

# tagged, added commit messages
git tag -a r0.12.1

# pushed
git push origin r0.12.1
@ctb ctb added the doc documentation content or issues label Feb 10, 2024
@ctb
Copy link
Contributor Author

ctb commented Feb 10, 2024

🤦 also probably want to bump version in src/core/Cargo.toml first.

@ctb
Copy link
Contributor Author

ctb commented Feb 10, 2024

@ctb
Copy link
Contributor Author

ctb commented Feb 10, 2024

@luizirber
Copy link
Member

There is also a changelog for the Rust crate in https://github.com/sourmash-bio/sourmash/blob/latest/src/core/CHANGELOG.md

@ctb
Copy link
Contributor Author

ctb commented Feb 22, 2024

checklist:

@ctb
Copy link
Contributor Author

ctb commented Feb 23, 2024

so as you can see from the above and from #3033 my process is:

  • verify that all the items on the checklist are good to go
  • update the things that need to be updated in a PR
  • after the PR is merged, I will run the tagging that triggers github actions:
# tagged, added commit messages
git tag -a r0.13.0

# pushed
git push origin r0.13.0

ctb added a commit that referenced this issue Feb 23, 2024
)

Updates `src/core/CHANGELOG.md` with release notes; see below.

## Release checklist

from
#2987 (comment):

- [x] verify minimum supported rust version (MSRV) for writing release
notes (see #2988 for an
example); MSRV is checked by CI in `.github/workflows/rust.yml`,
`minimum_rust_version`
- [x] write release notes using `git log --oneline r0.12.0..latest
src/core | cut -d\ -f2- > /tmp/out.txt`
- [x] verify that the ChangeLog is up to date:
https://github.com/sourmash-bio/sourmash/blob/latest/src/core/CHANGELOG.md
- [x] bump version in `src/core/Cargo.toml`

## Release notes for r0.13.0

MSRV: 1.65

Changes/additions:

* Calculate all gather stats in rust; use for rocksdb gather (#2943)
* adjust protein ksize for record/manifest (#3019)
* Allow changing storage location for a collection in RevIndex (#3015)
* make core Manifest booleans python compatible (core) (#3007)

Updates:
* Bump roaring from 0.10.2 to 0.10.3 (#3014)
* Bump histogram from 0.9.0 to 0.9.1 (#3002)
* Bump chrono from 0.4.33 to 0.4.34 (#3000)
* Bump web-sys from 0.3.67 to 0.3.68 (#2998)
* Bump num-iter from 0.1.43 to 0.1.44 (#2997)
* Bump wasm-bindgen-test from 0.3.40 to 0.3.41 (#2996)
@ctb
Copy link
Contributor Author

ctb commented Jun 10, 2024

example! #3199

ctb added a commit that referenced this issue Sep 25, 2024
from
#2987 (comment):

- [x] verify minimum supported rust version (MSRV) for writing release
notes (see #2988 for an
example); MSRV is checked by CI in `.github/workflows/rust.yml`,
`minimum_rust_version`
- [x] write release notes using `git log --oneline r0.12.0..latest
src/core | cut -d\ -f2- > /tmp/out.txt`
- [x] verify that the ChangeLog is up to date:
https://github.com/sourmash-bio/sourmash/blob/latest/src/core/CHANGELOG.md
- [x] bump version in `src/core/Cargo.toml`

# Release notes:

## [0.15.2] - 2024-09-25

MSRV: 1.65

Changes/additions:
* add `Manifest::intersect_manifest` to Rust core (#3305)
* propagate error from `RocksDB::open` on bad directory (#3306, #3307)

Updates:

* Bump getset from 0.1.2 to 0.1.3 (#3328)
* Bump memmap2 from 0.9.4 to 0.9.5 (#3326)
* Bump codspeed-criterion-compat from 2.6.0 to 2.7.2 (#3324)
* Bump serde_json from 1.0.127 to 1.0.128 (#3316)
* Bump serde from 1.0.209 to 1.0.210 (#3318)
* Bump serde from 1.0.208 to 1.0.209 (#3310)
* Bump serde_json from 1.0.125 to 1.0.127 (#3309)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc documentation content or issues
Projects
None yet
Development

No branches or pull requests

2 participants