chore: release

[frol]

🤖 New release

• borsh: 0.10.3 -> 0.11.0 (✓ API compatible changes)
• borsh-derive: 0.10.3 -> 0.10.4
• borsh-derive-internal: 0.10.3 -> 0.11.0 (✓ API compatible changes)
• borsh-schema-derive-internal: 0.10.3 -> 0.10.4 (✓ API compatible changes)

Changelog

borsh

0.11.0 - 2023-05-31

Added

• add BorshSchema for PhantomData, BTreeMap and BTreeSet (#93)
• Add optional bson::oid::ObjectId support (#135)
• [breaking] ser/de enum discriminant (#138)
• Add optional bytes/bytesmut support (#132)
• (deserialize) prevent unbound allocation (#129)
• Implement serialize/deserialize for core::ops::Range (#124)
• (de) add EnumExt trait with deserialize_variant method (#123)
• implement deserialize_reader (#116)
• Add clone impls to borsh schema types (#97)
• impl ser/de and schema for (T,) (#100)
• add proper support for isize and usize (#99)
• impl BorshSchema for HashSet (#83)
• (infra) introduce automated publishing (#67)
• Implemented (de)serialization for nonzero integer (#66)
• Rewrite the CI (#57)
• implement const-generics under feature (#38)
• impl (de)ser for PhantomData (#37)
• implement schema for arrays and fix box bounds (#36)
• [breaking] Eliminate unsafe code from both ser and de of u8 (#26)
• make schema same as de/serialization (#22)
• avoid collisions of imports due to derive-generated code (#14)
• Added support for BTreeMap, BTreeSet, BinaryHeap, LinkedList types (#6)

Fixed

• no-std tests did not run due to dev-dependencies re-enabling std feature (#144)
• Fix "reader with too much data" test (#118)
• remove unnecessary trait bounds requirements for array (#104)
• codegen sanity for enum serialization (#102)
• new clippy warnings (#105)
• fixes maybstd imports for no_std on thumbv6m-none-eabi (#87)
• delete schema for char (#101)
• maybestd rc feature imports (#88)
• fix no_std compatability (#79)
• Mark is_u8 unsafe to communicate potential undefined behavior if implemented not wisely (#21)
• Fixed symlinks to the README files after reorg

Other

• use release-plz and specify common rust version correctly (#134)

• Upgrade plain-HTTP links to HTTPS in Cargo.toml files (#141)

• Silenced clippy::uninlined_format_args lints to fix CI without bumping MSRV (#125)

• Prepare for 0.10.0 release (#121)

• bump hashbrown to 0.13 (#120)

• remove const-generics feature impls (#107)

• remove inconsistent duplicate hashbrown imports (#89)

• upgrade hashbrown (#53)

• fix clippy warnings (#47)

• Release 0.9.1

• Add serialization helpers to improve api ergonomics (#34)

• Added an example of direct BorshSerialize::serialize usage with vector and slice buffers (#29)

• Implement ser/de for reference count types (#27)

• Release 0.9.0

• Remove hasher bound on map and set ser/de (#16)

• Release 0.8.2

• Add seriailize and deserialize usize (#9)

• v0.8.1

• Enabled check code formatting on CI (#4)

• Add optional BSON object id support

---

This PR was generated with release-plz.

[frol]

@MarcoIeni I probably need your help to understand what is going on here. There were only 5 commits since v0.10.3: borsh-v0.10.3...master, but the CHANGELOG picks up older commits as well. Is there a way to fix it?

[frol]

git-cliff produces the changelog correctly, by the way:

[frol]

@MarcoIeni Another thing that bothers me is the reported versions.

What is "(✓ API compatible changes)"? release-plz mentions it in both "0.10.3 -> 0.11.0" and "0.10.3 -> 0.10.4" version ticks, and also it is a bit misleading that there is a mix of versions given that the version is pinned to the whole workspace.

[MarcoIeni]

the CHANGELOG picks up older commits as well. Is there a way to fix it?

Release-plz doesn't like the 0.0.0 version of your old Cargo.toml.

To fix this, just update the version (if v0.11.0 isn't correct) and the changelog of this PR manually and then merge the PR (when you want to release the new version). This error shouldn't happen again in the future because now the Cargo.toml has the correct version in it 👍

git-cliff produces the changelog correctly, by the way:

That's because git-cliff analyzes the tags, while release-plz compares the single commits with what's published in crates.io.

What is "(✓ API compatible changes)"?

It's the outcome of cargo-semver-checks. It means that the tool didn't identify breaking changes in your library code. You can disable the check with this config field.

"0.10.3 -> 0.10.4"

That's a bug I fixed in MarcoIeni/release-plz#802
I will release the new version of release-plz in 2-3 hours. 👍

Thanks for the bug report 🙏
Tell me if you still have other doubts 👍

[MarcoIeni]

I released the new release-plz version 👍
You should see the correct GitHub description on the next commit in the master branch 👍

[frol]

@MarcoIeni I am sorry to bother you again, but the next release initially constructed a correct CHANGELOG and properly suggested to cut 0.11.1 release (see the history of changes of that PR description), but with one more commit to master, it broke the CHANGELOG (exploded with old changes) and now it suggests to cut 0.12.0 release which and I don't understand why (I expected #142 to be a non-breaking change).

Also, I don't understand how to read those "(✓ API compatible changes)" notes - borsh-derive is the only package that does not have the note:

• borsh: 0.11.0 -> 0.12.0 (✓ API compatible changes)
• borsh-derive: 0.11.0 -> 0.12.0
• borsh-derive-internal: 0.11.0 -> 0.12.0 (✓ API compatible changes)
• borsh-schema-derive-internal: 0.11.0 -> 0.12.0 (✓ API compatible changes)

[MarcoIeni]

Oops, apparently there's an issue with symlinks 😅
I will try to fix it. In the meantime, you can again edit the PR manually and merge 👍

I am sorry to bother you again

No worries at all, thanks for pinging me when you find issues in release-plz. It helps me making it better :)

Also, I don't understand how to read those "(✓ API compatible changes)" notes

I created MarcoIeni/release-plz#811

I think borsh-derive is not checked because it's a proc-macro. But this is just a guess 🤔

[MarcoIeni]

Hi Vlad! Some news from me:

• I didn't fix the symlink issue yet. However in chore: stop looking at git history if commit tagged MarcoIeni/release-plz#813 I implemented a "safety check" where I stop looking back at commits older than the previous tag. This should stop release-plz from showing all the git history in the changelog 👍
• I documented semver-check here. Please, let me know if you have still doubts about it.

I tested release-plz update in this repo, and it seems to work fine, so I expect release-plz to fix #146 on the next commit you push on master 👍

Again, thanks for your patience, and for reporting issues 🙏

[frol]

@MarcoIeni Thanks for all your support! I am breaking your tool with our obscure cases almost daily 😄 This time we yanked the most recent version and now release-plz does not pick new commits to master as candidates to the new release: https://github.com/near/borsh-rs/actions/runs/5277864683/jobs/9546500990

[MarcoIeni]

Hi! Have you looked at https://marcoieni.github.io/release-plz/extra/yanked-packages.html ?

[frol]

@MarcoIeni Thanks for the pointer!