From d7565f9e2fdec826c0e9b996e5ff5e25e71f16eb Mon Sep 17 00:00:00 2001 From: Kamil Sopko Date: Thu, 25 Jun 2026 17:44:00 +0200 Subject: [PATCH 1/2] =?UTF-8?q?chore:=20release=200.1.1=20=E2=80=94=20fix?= =?UTF-8?q?=20docs.rs=20build,=20add=20subcrate=20navigation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - xtax-blob-storage: add #![cfg_attr(docsrs, feature(doc_cfg))] to fix docs.rs build - xtax-blob-storage: bump to 0.1.1 - xtax facade: bump to 0.1.1, add docs.rs subcrate links to lib.rs - README: add Documentation table with docs.rs + guide links - README: add Codacy badge --- Cargo.lock | 4 ++-- Cargo.toml | 4 ++-- README.md | 9 +++++++++ crates/xtax-blob-storage/Cargo.toml | 2 +- crates/xtax-blob-storage/README.md | 4 ++++ crates/xtax-blob-storage/src/lib.rs | 2 ++ crates/xtax-encryption/README.md | 4 ++++ src/lib.rs | 7 +++++++ 8 files changed, 31 insertions(+), 5 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index db5ed55..79675d0 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -2899,7 +2899,7 @@ checksum = "66fee0b777b0f5ac1c69bb06d361268faafa61cd4682ae064a171c16c433e9e4" [[package]] name = "xtax" -version = "0.1.0" +version = "0.1.1" dependencies = [ "xtax-blob-storage", "xtax-encryption", @@ -2907,7 +2907,7 @@ dependencies = [ [[package]] name = "xtax-blob-storage" -version = "0.1.0" +version = "0.1.1" dependencies = [ "async-trait", "aws-config", diff --git a/Cargo.toml b/Cargo.toml index fba6031..3e5d1f0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "xtax" -version = "0.1.0" +version = "0.1.1" edition.workspace = true rust-version.workspace = true license.workspace = true @@ -30,7 +30,7 @@ encryption = ["dep:xtax-encryption"] full = ["blob-storage-full", "encryption"] [dependencies] -xtax-blob-storage = { version = "0.1.0", path = "crates/xtax-blob-storage", optional = true, default-features = false } +xtax-blob-storage = { version = "0.1.1", path = "crates/xtax-blob-storage", optional = true, default-features = false } xtax-encryption = { version = "0.1.0", path = "crates/xtax-encryption", optional = true } [workspace] diff --git a/README.md b/README.md index c2dd0f2..637d14e 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Dependabot](https://img.shields.io/badge/dependabot-active-blue?logo=dependabot)](https://github.com/cz-jcode/xtax/network/updates) [![crates.io](https://img.shields.io/crates/v/xtax.svg)](https://crates.io/crates/xtax) [![docs.rs](https://docs.rs/xtax/badge.svg)](https://docs.rs/xtax) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5f6106e413274dfcac3179c96ed643bf)](https://app.codacy.com/gh/cz-jcode/xtax/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) Rust infrastructure ecosystem — a Cargo workspace of independent, composable crates. @@ -80,6 +81,14 @@ Both paths are valid and supported. Default features: **none**. You opt in to exactly what you need. +## Documentation + +| Crate | docs.rs | Guides | +|-------|---------|--------| +| `xtax` (facade) | [docs.rs](https://docs.rs/xtax) | — | +| `xtax-blob-storage` | [docs.rs](https://docs.rs/xtax-blob-storage) | [Guide](crates/xtax-blob-storage/docs/guide.md) · [Architecture](crates/xtax-blob-storage/docs/architecture.md) · [Backends](crates/xtax-blob-storage/docs/backends.md) · [Encryption](crates/xtax-blob-storage/docs/encryption.md) · [All docs](crates/xtax-blob-storage/docs/) | +| `xtax-encryption` | [docs.rs](https://docs.rs/xtax-encryption) | [README](crates/xtax-encryption/README.md) | + ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) for release/publishing instructions and contribution guidelines. diff --git a/crates/xtax-blob-storage/Cargo.toml b/crates/xtax-blob-storage/Cargo.toml index 638fd8a..13a5dea 100644 --- a/crates/xtax-blob-storage/Cargo.toml +++ b/crates/xtax-blob-storage/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "xtax-blob-storage" -version = "0.1.0" +version = "0.1.1" edition.workspace = true rust-version.workspace = true license.workspace = true diff --git a/crates/xtax-blob-storage/README.md b/crates/xtax-blob-storage/README.md index 05da9cc..8a87009 100644 --- a/crates/xtax-blob-storage/README.md +++ b/crates/xtax-blob-storage/README.md @@ -1,7 +1,11 @@ # xtax-blob-storage +[![CI](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml) +[![CodeQL](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml) +[![Dependabot](https://img.shields.io/badge/dependabot-active-blue?logo=dependabot)](https://github.com/cz-jcode/xtax/network/updates) [![crates.io](https://img.shields.io/crates/v/xtax-blob-storage.svg)](https://crates.io/crates/xtax-blob-storage) [![docs.rs](https://docs.rs/xtax-blob-storage/badge.svg)](https://docs.rs/xtax-blob-storage) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5f6106e413274dfcac3179c96ed643bf)](https://app.codacy.com/gh/cz-jcode/xtax/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) > **Experimental** blob storage abstraction for Rust with filesystem and S3 > backends, streaming uploads, optional encryption, and composable layers. diff --git a/crates/xtax-blob-storage/src/lib.rs b/crates/xtax-blob-storage/src/lib.rs index 3cbd761..191c8b7 100644 --- a/crates/xtax-blob-storage/src/lib.rs +++ b/crates/xtax-blob-storage/src/lib.rs @@ -1,3 +1,5 @@ +#![cfg_attr(docsrs, feature(doc_cfg))] + //! # xtax-blob-storage //! //! > **Experimental** blob storage abstraction for Rust with filesystem and S3 diff --git a/crates/xtax-encryption/README.md b/crates/xtax-encryption/README.md index ccfd0cb..8b93558 100644 --- a/crates/xtax-encryption/README.md +++ b/crates/xtax-encryption/README.md @@ -1,7 +1,11 @@ # xtax-encryption +[![CI](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/ci.yml) +[![CodeQL](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml/badge.svg)](https://github.com/cz-jcode/xtax/actions/workflows/codeql.yml) +[![Dependabot](https://img.shields.io/badge/dependabot-active-blue?logo=dependabot)](https://github.com/cz-jcode/xtax/network/updates) [![crates.io](https://img.shields.io/crates/v/xtax-encryption.svg)](https://crates.io/crates/xtax-encryption) [![docs.rs](https://docs.rs/xtax-encryption/badge.svg)](https://docs.rs/xtax-encryption) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5f6106e413274dfcac3179c96ed643bf)](https://app.codacy.com/gh/cz-jcode/xtax/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) > **Trait-only** encryption provider interface — no backend, no storage, > no I/O decisions. diff --git a/src/lib.rs b/src/lib.rs index 1d8cc4c..08ee515 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -69,6 +69,13 @@ //! | `encryption` | `xtax-encryption` | Trait-only encryption provider interface | //! | `full` | all facade features | Enables all currently exposed facade features | //! +//! ## Subcrate documentation +//! +//! | Crate | Documentation | +//! |-------|---------------| +//! | `xtax-blob-storage` | [docs.rs](https://docs.rs/xtax-blob-storage) | +//! | `xtax-encryption` | [docs.rs](https://docs.rs/xtax-encryption) | +//! //! ## Architecture //! //! - The `xtax` facade crate contains **no logic**. From 25640664b21681736b5a752ee605763cb36990a8 Mon Sep 17 00:00:00 2001 From: Kamil Sopko Date: Thu, 25 Jun 2026 17:45:00 +0200 Subject: [PATCH 2/2] docs: update README --- crates/xtax-blob-storage/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/xtax-blob-storage/README.md b/crates/xtax-blob-storage/README.md index 8a87009..b4f2a30 100644 --- a/crates/xtax-blob-storage/README.md +++ b/crates/xtax-blob-storage/README.md @@ -80,7 +80,7 @@ tokio = { version = "1.52", features = ["rt", "io-util"] } No database. No gRPC. No framework lock-in. Just blobs. -## Features +## Features flags | Feature | Dependencies | When to use | |---------|-------------|-----------------------|