From 34b174157526c185ab377dcd30383632e7b8d2ce Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Fri, 20 Dec 2024 10:31:18 +0100 Subject: [PATCH 1/4] core: Add readme and changelog --- Cargo.toml | 3 ++- core/CHANGELOG.md | 5 +++++ core/Cargo.toml | 2 ++ core/README.md | 14 ++++++++++++++ 4 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 core/CHANGELOG.md create mode 100644 core/README.md diff --git a/Cargo.toml b/Cargo.toml index fd62c984749..681f0c18928 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,6 +6,7 @@ authors = ["The Trussed developers", "Nicolas Stalder ", "Nitrokey edition = "2021" homepage = "https://trussed.dev" license = "Apache-2.0 OR MIT" +repository = "https://github.com/trussed-dev/trussed" [workspace.dependencies] heapless-bytes = "0.3" @@ -17,7 +18,6 @@ serde = { version = "1.0", default-features = false, features = ["derive"] } [package] name = "trussed" version = "0.1.0" -repository = "https://github.com/trussed-dev/trussed" description = "Modern Cryptographic Firmware" readme = "README.md" @@ -25,6 +25,7 @@ authors.workspace = true edition.workspace = true homepage.workspace = true license.workspace = true +repository.workspace = true [dependencies] trussed-core = { version = "0.1", path = "core" } diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md new file mode 100644 index 00000000000..cdf64aab779 --- /dev/null +++ b/core/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## Unreleased + +- diff --git a/core/Cargo.toml b/core/Cargo.toml index cc169c8bfa8..786a188482e 100644 --- a/core/Cargo.toml +++ b/core/Cargo.toml @@ -1,11 +1,13 @@ [package] name = "trussed-core" version = "0.1.0" +description = "Core types for the trussed crate" authors.workspace = true edition.workspace = true homepage.workspace = true license.workspace = true +repository.workspace = true [dependencies] heapless-bytes.workspace = true diff --git a/core/README.md b/core/README.md new file mode 100644 index 00000000000..b9543a88ab5 --- /dev/null +++ b/core/README.md @@ -0,0 +1,14 @@ +# trussed-core + +Core types for the [`trussed`][] crate. + +This crate contains the Trussed client traits and other types that are needed by applications. +See the [`trussed`][] crate for more information. + +[`trussed`]: https://github.com/trussed-dev/trussed + +#### License + +`trussed` is licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option. +
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. From fb3b6d05ea7ed166ea85c6ca496150c89276e423 Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Fri, 20 Dec 2024 10:35:09 +0100 Subject: [PATCH 2/4] core: Improve documentation builds --- core/Cargo.toml | 3 +++ core/src/lib.rs | 1 + 2 files changed, 4 insertions(+) diff --git a/core/Cargo.toml b/core/Cargo.toml index 786a188482e..44c53137823 100644 --- a/core/Cargo.toml +++ b/core/Cargo.toml @@ -53,3 +53,6 @@ tdes = [] totp = [] trng = [] x255 = [] + +[package.metadata.docs.rs] +all-features = true diff --git a/core/src/lib.rs b/core/src/lib.rs index 55664fb5dd4..13ad7318cc5 100644 --- a/core/src/lib.rs +++ b/core/src/lib.rs @@ -1,4 +1,5 @@ #![cfg_attr(not(test), no_std)] +#![cfg_attr(docsrs, feature(doc_auto_cfg))] //! Core types for the [`trussed`][] crate. //! From f5d4af2733a33305d044f763f12dc31d417b57ee Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Fri, 20 Dec 2024 10:35:59 +0100 Subject: [PATCH 3/4] Use patch instead of path dependency for trussed-core Using a path dependency would mean that we cannot patch trussed without also patching trussed-core. --- Cargo.toml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index 681f0c18928..826d1736791 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -28,7 +28,7 @@ license.workspace = true repository.workspace = true [dependencies] -trussed-core = { version = "0.1", path = "core" } +trussed-core = { version = "0.1" } # general bitflags = { version = "2.1" } @@ -212,3 +212,6 @@ required-features = ["crypto-client", "default-mechanisms", "virt"] [package.metadata.docs.rs] features = ["serde-extensions", "virt"] rustdoc-args = ["--cfg", "docsrs"] + +[patch.crates-io] +trussed-core.path = "core" From 6bba8fde36d05c0227769eb63345744e87d84b2b Mon Sep 17 00:00:00 2001 From: Robin Krahl Date: Fri, 20 Dec 2024 10:39:31 +0100 Subject: [PATCH 4/4] Release trussed-core v0.1.0-rc.1 --- Cargo.toml | 2 +- core/CHANGELOG.md | 5 +++++ core/Cargo.toml | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 826d1736791..355324de12e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -28,7 +28,7 @@ license.workspace = true repository.workspace = true [dependencies] -trussed-core = { version = "0.1" } +trussed-core = { version = "0.1.0-rc.1" } # general bitflags = { version = "2.1" } diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md index cdf64aab779..624525aeb95 100644 --- a/core/CHANGELOG.md +++ b/core/CHANGELOG.md @@ -3,3 +3,8 @@ ## Unreleased - + +## [v0.1.0-rc.1](https://github.com/trussed-dev/trussed/releases/tag/core-v0.1.0-rc.1) (2024-12-20) + +Initial release extracting the core types from `trussed`: the client traits, +the API definition and the types used in the API. diff --git a/core/Cargo.toml b/core/Cargo.toml index 44c53137823..c94b7969745 100644 --- a/core/Cargo.toml +++ b/core/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "trussed-core" -version = "0.1.0" +version = "0.1.0-rc.1" description = "Core types for the trussed crate" authors.workspace = true