Add release-plz to CI

Author: yaahc

.github/workflows/ci.yml

@@ -60,7 +60,7 @@ jobs:
           args: --all ${{ matrix.features }}
 
   test-msrv:
-    name: Test Suite
+    name: Test Suite (msrv)
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -82,7 +82,7 @@ jobs:
           args: --all ${{ matrix.features }}
 
   test-os:
-    name: Test Suite
+    name: Test Suite (os)
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:

.github/workflows/release-plz.yml

@@ -0,0 +1,60 @@
+name: Release-plz
+
+permissions:
+  pull-requests: write
+  contents: write
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+
+  # Release unpublished packages.
+  release-plz-release:
+    name: Release-plz release
+    runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'eyre-rs' }}
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Run release-plz
+        uses: release-plz/[email protected]
+        with:
+          command: release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+
+  # Create a PR with the new versions and changelog, preparing the next release.
+  release-plz-pr:
+    name: Release-plz PR
+    runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'eyre-rs' }}
+    permissions:
+      contents: write
+      pull-requests: write
+    concurrency:
+      group: release-plz-${{ github.ref }}
+      cancel-in-progress: false
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+      - name: Run release-plz
+        uses: release-plz/[email protected]
+        with:
+          command: release-pr
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}

Cargo.lock

@@ -44,40 +44,6 @@ rustdoc-args = ["--cfg", "docsrs"]
 [package.metadata.release]
 dev-version = false
 
-[[package.metadata.release.pre-release-replacements]]
-file = "CHANGELOG.md"
-search = "Unreleased"
-replace="{{version}}"
-
-[[package.metadata.release.pre-release-replacements]]
-file = "src/lib.rs"
-search = "#!\\[doc\\(html_root_url.*"
-replace = "#![doc(html_root_url = \"https://docs.rs/{{crate_name}}/{{version}}\")]"
-exactly = 1
-
-[[package.metadata.release.pre-release-replacements]]
-file = "CHANGELOG.md"
-search = "\\.\\.\\.HEAD"
-replace="...{{tag_name}}"
-exactly = 1
-
-[[package.metadata.release.pre-release-replacements]]
-file = "CHANGELOG.md"
-search = "ReleaseDate"
-replace="{{date}}"
-
-[[package.metadata.release.pre-release-replacements]]
-file="CHANGELOG.md"
-search="<!-- next-header -->"
-replace="<!-- next-header -->\n\n## [Unreleased] - ReleaseDate"
-exactly=1
-
-[[package.metadata.release.pre-release-replacements]]
-file="CHANGELOG.md"
-search="<!-- next-url -->"
-replace="<!-- next-url -->\n[Unreleased]: https://github.com/eyre-rs/{{crate_name}}/compare/{{tag_name}}...HEAD"
-exactly=1
-
 [[example]]
 name = "color-eyre-usage"
 path = "examples/usage.rs"

color-eyre/Cargo.toml

@@ -486,7 +486,7 @@ impl HookBuilder {
     ///     .unwrap();
     ///
     /// impl PanicMessage for MyPanicMessage {
-    ///     fn display(&self, pi: &std::panic::PanicInfo<'_>, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+    ///     fn display(&self, pi: &std::panic::PanicHookInfo<'_>, f: &mut fmt::Formatter<'_>) -> fmt::Result {
     ///         writeln!(f, "{}", "The application panicked (crashed).".red())?;
     ///
     ///         // Print panic message.
@@ -790,7 +790,11 @@ fn eyre_frame_filters(frames: &mut Vec<&Frame>) {
 struct DefaultPanicMessage(Theme);
 
 impl PanicMessage for DefaultPanicMessage {
-    fn display(&self, pi: &std::panic::PanicInfo<'_>, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+    fn display(
+        &self,
+        pi: &std::panic::PanicHookInfo<'_>,
+        f: &mut fmt::Formatter<'_>,
+    ) -> fmt::Result {
         // XXX is my assumption correct that this function is guaranteed to only run after `color_eyre` was setup successfully (including setting `THEME`), and that therefore the following line will never panic? Otherwise, we could return `fmt::Error`, but if the above is true, I like `unwrap` + a comment why this never fails better
         let theme = &self.0;
 
@@ -822,7 +826,7 @@ impl PanicMessage for DefaultPanicMessage {
 /// A type representing an error report for a panic.
 pub struct PanicReport<'a> {
     hook: &'a PanicHook,
-    panic_info: &'a std::panic::PanicInfo<'a>,
+    panic_info: &'a std::panic::PanicHookInfo<'a>,
     backtrace: Option<backtrace::Backtrace>,
     #[cfg(feature = "capture-spantrace")]
     span_trace: Option<tracing_error::SpanTrace>,
@@ -949,7 +953,7 @@ impl PanicHook {
     /// Convert self into the type expected by `std::panic::set_hook`.
     pub fn into_panic_hook(
         self,
-    ) -> Box<dyn Fn(&std::panic::PanicInfo<'_>) + Send + Sync + 'static> {
+    ) -> Box<dyn Fn(&std::panic::PanicHookInfo<'_>) + Send + Sync + 'static> {
         Box::new(move |panic_info| {
             eprintln!("{}", self.panic_report(panic_info));
         })
@@ -959,7 +963,7 @@ impl PanicHook {
     /// `Display` trait.
     pub fn panic_report<'a>(
         &'a self,
-        panic_info: &'a std::panic::PanicInfo<'_>,
+        panic_info: &'a std::panic::PanicHookInfo<'_>,
     ) -> PanicReport<'a> {
         let v = panic_verbosity();
         let capture_bt = v != Verbosity::Minimal;

color-eyre/src/config.rs

@@ -355,7 +355,7 @@
     unused_parens,
     while_true
 )]
-#![allow(clippy::try_err)]
+#![allow(clippy::try_err, clippy::uninlined_format_args)]
 
 use std::sync::Arc;
 

color-eyre/src/lib.rs

@@ -326,8 +326,12 @@ pub trait Section: crate::private::Sealed {
     fn suppress_backtrace(self, suppress: bool) -> Self::Return;
 }
 
-/// Trait for printing a panic error message for the given PanicInfo
+/// Trait for printing a panic error message for the given PanicHookInfo
 pub trait PanicMessage: Send + Sync + 'static {
     /// Display trait equivalent for implementing the display logic
-    fn display(&self, pi: &std::panic::PanicInfo<'_>, f: &mut fmt::Formatter<'_>) -> fmt::Result;
+    fn display(
+        &self,
+        pi: &std::panic::PanicHookInfo<'_>,
+        f: &mut fmt::Formatter<'_>,
+    ) -> fmt::Result;
 }

color-eyre/src/section/mod.rs

@@ -2,6 +2,7 @@ use color_eyre::eyre;
 use eyre::eyre;
 
 #[test]
+#[allow(clippy::uninlined_format_args)]
 fn enabled() {
     color_eyre::config::HookBuilder::default()
         .display_env_section(true)

color-eyre/tests/bt_enabled.rs

@@ -1,5 +1,6 @@
 #[cfg(feature = "track-caller")]
 #[test]
+#[allow(clippy::uninlined_format_args)]
 fn disabled() {
     use color_eyre::eyre;
     use eyre::eyre;

color-eyre/tests/location_disabled.rs

@@ -360,6 +360,7 @@
 #![allow(
     clippy::needless_doctest_main,
     clippy::new_ret_no_self,
+    clippy::uninlined_format_args,
     clippy::wrong_self_convention
 )]