feat(iroh-net): add deprecation notice, bump to 0.28.2

[flub]

Description

Too many users are finding this crate and trying to use it. Make it obvious where they should be looking instead.

Closes #3075.

Breaking Changes

Notes & open questions

• This targets the new maint-0.28 branch which starts off the v0.28.1 tag.
• Only the iroh-net crate has a new version number, I believe only publishing this crate makes the most sense.

Change checklist

• Self-review.
• Documentation updates following the style guide, if relevant.
• Tests if relevant.
• All breaking changes documented.

[flub]

I guess CI will just have to be sad?

[flub]

cargo publish -p iroh-net --dry-run works on this branch.

[matheus23]

Should we perhaps put a deprecation on ... all of the API? So if they use it, their editor tells them to use the new crate?

I tested a basic

#![deprecated(
    note = "this crate has been renamed from 'iroh-net' to 'iroh', please use that crate instead"
)]

in iroh-net/src/lib.rs. Seems to work.

[flub]

Should we perhaps put a deprecation on ... all of the API? So if they use it, their editor tells them to use the new crate?

I think that's a bit harsh. There is nothing wrong with this crate and there are legitimate reasons why someone might not have upgraded yet.

[matheus23]

Well, to be fair, people would only see that when the install the latest version of iroh-net, not if they just keep depending on 0.28.1, which wouldn't have these deprecation warnings.

[matheus23]

@flub can we merge this? And can we get someone who has release rights (@dignifiedquire @ramfox ?) to cut a release?

[flub]

Does it work though? The adding of deprecations had all sorts of weird errors that I didn't dig into, so I'm not sure this is actually releasable as-is.

…

On Mon, 20 Jan 2025, at 13:37, Philipp Krüger wrote: @flub <https://github.com/flub> can we merge this? And can we get someone who has release rights ***@***.*** <https://github.com/dignifiedquire> @ramfox <https://github.com/ramfox> ?) to cut a release? — Reply to this email directly, view it on GitHub <#3116 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABD2IB5PC63HS5PJQZXD3T2LTUXDAVCNFSM6AAAAABU6AMR5GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMBSGMYTONZTGE>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[flub]

Ok, ran tests, built the docs, did a publish dry-run and all is fine and dandy. I did all this with just -p iroh-net not for all crates. So I'm going to merge this.