xtax 0.1.1

xTax Rust infrastructure ecosystem — a Cargo workspace of independent, composable crates.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# Contributing to xtax

Thanks for considering contributing! This document outlines the basics to get started.

## Development setup

```bash
git clone https://github.com/cz-jcode/xtax
cd xtax
cargo build --workspace
```

## Running tests

```bash
# Full workspace
cargo test --workspace --all-features

# Individual crate
cargo test -p xtax-blob-storage --all-features

# Specific feature combo
cargo test -p xtax-blob-storage --no-default-features
cargo test -p xtax-blob-storage --features fs
```

## Code quality

CI enforces these checks on every PR (see [ci.yml](.github/workflows/ci.yml)):

```bash
cargo fmt --all --check
cargo clippy --workspace --all-features -- -D warnings
```

Run them locally before pushing to avoid round-trips.

## Pull requests

1. Fork the repo and create a branch from `main`.
2. Make your changes — keep them focused and well-scoped.
3. Run `cargo fmt` and `cargo clippy` locally.
4. Ensure all tests pass: `cargo test --workspace --all-features`.
5. Open a PR against `main`. CI will run automatically.
6. PRs need at least one approving review before merge.

## Architecture rules

- The `xtax` facade crate contains **no logic** — only re-exports.
- Each subcrate has **standalone value** and can be used independently.
- Subcrates **must not** depend on the facade crate.
- Dependency direction: `xtax` → subcrate, never the reverse.
- Private/internal application glue must stay out of public crates.

## Releasing / Publishing

Releases use **lockstep versioning**: all crates share the same version number.
Pushing a single `v*` tag triggers `release.yml`, which validates that all three
crates have matching versions, then publishes them to [crates.io](https://crates.io)
in order: `xtax-encryption` → `xtax-blob-storage` → `xtax`.

| Tag        | Workflow         | What it publishes                           |
|------------|------------------|---------------------------------------------|
| `v*`       | `release.yml`    | `xtax-encryption`, `xtax-blob-storage`, `xtax` |

### Step-by-step

1. Bump the version in **all three** `Cargo.toml` files to the same version:
   - `Cargo.toml` (root — facade + dependency versions)
   - `crates/xtax-encryption/Cargo.toml`
   - `crates/xtax-blob-storage/Cargo.toml`
2. Update any intra-workspace dependency versions (e.g. `xtax-blob-storage` → `xtax-encryption`).
3. Commit and push to `main`. Wait for CI to pass.
4. Create and push a single tag:
   ```bash
   git tag v0.1.1
   git push origin v0.1.1
   ```
5. `release.yml` will:
   - Extract the version from the tag
   - Validate that all three crates have the same version
   - Publish each crate (skipping any that already exist on crates.io)
   - Create a GitHub Release with auto-generated notes

> **Note:** Publishing requires a `release` environment with a `CARGO_REGISTRY_TOKEN`
> secret configured in the GitHub repository settings.