From 55117007289978a17d1e92a9b1a5b948c204abff Mon Sep 17 00:00:00 2001 From: Freja Roberts Date: Fri, 2 Feb 2024 22:13:48 +0100 Subject: [PATCH 1/2] chore: backport missing changelog notes from previous manual releases --- eyre/CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/eyre/CHANGELOG.md b/eyre/CHANGELOG.md index 4183085..76ce032 100644 --- a/eyre/CHANGELOG.md +++ b/eyre/CHANGELOG.md @@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added - feature flag for `anyhow` compatibility traits [by LeoniePhiline](https://github.com/eyre-rs/eyre/pull/138) +## [0.6.12] - 2024-01-31 +### Fixed +- Unsound cast to invalid type during Report downcast [by ten3roberts](https://github.com/eyre-rs/eyre/pull/143) + ## [0.6.11] - 2023-12-13 ### Fixed - stale references to `Error` in docstrings [by birkenfeld](https://github.com/eyre-rs/eyre/pull/87) From 5aa71321c7adbbfc9b9ce9bc58c6649608e7020c Mon Sep 17 00:00:00 2001 From: Freja Roberts Date: Fri, 2 Feb 2024 22:22:57 +0100 Subject: [PATCH 2/2] feat: document release process --- CONTRIBUTING.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6465433..a6bef44 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -173,9 +173,27 @@ both high-quality and timely. Finally, if nothing brings you more satisfaction than seeing every last issue labeled and all resolved issues closed, feel free to message any Eyre Circle -Member (currently @yaahc) for the triage role to help us keep things tidy. This +Member (currently @yaahc and @ten3roberts) for the triage role to help us keep things tidy. This role only requires good faith and a basic understanding of our development process. [Discord]: https://discord.gg/z94RqmUTKB [^1]: Okay, I'll admit it, it's really just the Rust Project's CoC :sweat_smile: + +# Release Process + +The `master` branch contains all the latest changes and is considered unstable. + +For each bugfix and non-breaking change, the relevant commits are cherry-picked to relevant stable release branches, +denoted by `releas-.`. A new version is then published from each of the relevant stable release branches. + +Change logs are maintained on the `master` branch in the `CHANGELOG.md` file. Updating the changelog as part of a PR is +highly encouraged, but not strictly required. The changelog *should not* be maintained on the stable release branches or +in the release commits, as this leads to them not being visible on the `master` branch. + +## Publishing a new release +- Cherry pick the relevant commits to the relevant stable release branches +- Checkout the stable release branch, e.g. `release-0.6` +- Run `cargo release ` to publish a new release + - This will publish to `crates.io`, and create a new tagged git commit on the release branch, which is subsequently pushed to the remote. +[ WIP ] workspace wide release, pending #110 (color-eyre inclusion)