From 260e288b047dfc36c779df7f1bd31d5432a6f9af Mon Sep 17 00:00:00 2001 From: LuisFerLCC Date: Sun, 21 Sep 2025 22:35:51 -0600 Subject: [PATCH] Prepare release 0.1.0 --- Cargo.lock | 4 ++-- RELEASE.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++ SECURITY.md | 2 +- impl/Cargo.toml | 2 +- tests/Cargo.toml | 2 +- 5 files changed, 61 insertions(+), 5 deletions(-) create mode 100644 RELEASE.md diff --git a/Cargo.lock b/Cargo.lock index 06155d3..36dc187 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -29,7 +29,7 @@ dependencies = [ [[package]] name = "error-stack-macros2" -version = "0.0.0-reserved" +version = "0.1.0" dependencies = [ "error-stack", "proc-macro2", @@ -40,7 +40,7 @@ dependencies = [ [[package]] name = "error-stack-macros2-tests" -version = "0.0.0-reserved" +version = "0.1.0" dependencies = [ "error-stack", "error-stack-macros2", diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..c4e0e49 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,56 @@ +# `error-stack-macros2` v0.1.0 + +The very first development version of `error-stack-macros2` is finally here! + +## Features + +This version (0.1.0) offers a derive macro for the [`Error`](https://doc.rust-lang.org/stable/core/error/trait.Error.html) trait which encourages the best practices for defining [`error-stack`](https://crates.io/crates/error-stack) context types. + +Here's an example. This code: + +```rust +use std::{ + error::Error, + fmt::{self, Display, Formatter}, +}; + +#[derive(Debug)] +pub enum CreditCardError { + InvalidInput(String), + Other, +} + +impl Display for CreditCardError { + fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { + let msg = match self { + Self::InvalidInput(_) => "credit card not found", + Self::Other => "failed to retrieve credit card", + }; + + f.write_str(msg) + } +} + +impl Error for CreditCardError {} +``` + +...can now be reduced to this code: + +```rust +use error_stack_macros2::Error; + +#[derive(Debug, Error)] +pub enum CreditCardError { + #[display("credit card not found")] + InvalidInput(String), + + #[display("failed to retrieve credit card")] + Other, +} +``` + +This new release also means that we will now be listening to feedback and accepting new features (macros, obviously). We are also now committed to maintaining this macro going forward and keeping our dependencies up to date. + +## Previous release notes + +If you want to take a look at the notes from previous releases, go to [GitHub Releases](https://github.com/LuisFerLCC/error-stack-macros2/releases). diff --git a/SECURITY.md b/SECURITY.md index b3addf8..7033048 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,7 +4,7 @@ | Version | Supported | | ------- | --------- | -| - | - | +| 0.1.0 | ✅ | ## Report a vulnerability diff --git a/impl/Cargo.toml b/impl/Cargo.toml index 70c6320..563e35b 100644 --- a/impl/Cargo.toml +++ b/impl/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "error-stack-macros2" -version = "0.0.0-reserved" +version = "0.1.0" authors = ["LuisFerLCC"] edition = "2024" rust-version = "1.90.0" diff --git a/tests/Cargo.toml b/tests/Cargo.toml index 138780f..852700a 100644 --- a/tests/Cargo.toml +++ b/tests/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "error-stack-macros2-tests" -version = "0.0.0-reserved" +version = "0.1.0" authors = ["LuisFerLCC"] edition = "2024" rust-version = "1.90.0"