8 Commits

Author SHA1 Message Date
Thomas Eizinger
996b5c8bd0
chore: leverage cargo's workspace inheritance
Previously, we would specify the version and path of our workspace dependencies in each of our crates. This is error prone as https://github.com/libp2p/rust-libp2p/pull/3658#discussion_r1153278072 for example shows. Problems like these happened in the past too.

There is no need for us to ever depend on a earlier version than the most current one in our crates. It thus makes sense that we manage this version in a single place.

Cargo supports a feature called "workspace inheritance" which allows us to share a dependency declaration across a workspace and inherit it with `{ workspace = true }`.

We do this for all our workspace dependencies and for the MSRV.

Resolves #3787.

Pull-Request: #3715.
2023-05-02 09:14:14 +00:00
Thomas Eizinger
3411b2697c
docs: update policy on breaking changes and changelog entry format
Pull-Request: #3615.
2023-03-22 14:21:43 +00:00
Max Inden
1b09b8c85c
docs(release): Skip unused cargo release steps
`cargo release` provides multiple steps:
- changes
- version
- replace
- hook
- commit
- publish
- owner
- tag
- push
- config
- help

We only make use of `publish` and `tag`. We explicitly don't want `cargo release` to do `version` or `commit`.

Update the release docs accordingly, namely replace the generic `cargo release` with a two step process `cargo release publish` and `cargo release tag`.

Pull-Request: #3596.
2023-03-14 19:22:21 +00:00
Thomas Eizinger
d7bf56376e
docs(release): clarify how we handle alpha versions
Pull-Request: #3584.
2023-03-14 12:14:12 +00:00
Max Inden
79fce51f9b
docs(release): Document patch release process
Quick documentation update to describe patch release branching convention.

Pull-Request: #3490.
2023-02-23 01:03:25 +00:00
Max Inden
cec1a8d26f
docs/release: Document cargo-release process and mention root changelog (#3028)
* docs/release: Document cargo-release process

* docs/release: Document update to root level changelog.md
2022-10-20 20:56:02 +01:00
Max Inden
47c5c80433
docs/release: Only choose crate name not bench name (#1897)
Some `Cargo.toml` files contain multiple `name` fields, e.g. the crate name and
the benchmark name (see
https://github.com/libp2p/rust-libp2p/blob/master/core/Cargo.toml). Only choose
the first one when constructing the tag.
2020-12-18 11:35:39 +01:00
Max Inden
293f2f83af
docs/release.md: Add release documentation (#1712)
* docs/release.md: Add release documentation

* docs/release.md: Address comments

* docs/release.md: Add annotation -a option

* docs/release: Mention bumping Cargo.toml version

* docs/release.md: Extract name and version with sed

* docs/release.md: Remove instruction for release date in changelog
2020-08-27 11:32:27 +02:00