revolutx 0.3.0

Unofficial Rust SDK for the Revolut X Crypto Exchange REST API
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

# Crate release process

Publishing a new `revolutx` release to crates.io. Examples below use `v0.3.0`
as the new release tag — substitute the real versions. Get the previous tag with
`git describe --tags --abbrev=0` (the last published release is `v0.2.0`).

crates.io versions are **immutable**: once `cargo publish` succeeds you cannot
overwrite or re-upload that version (you can only *yank* it). Everything below
the publish step exists to make sure the artifact is correct *before* it goes
out.

`revolutx` is a **library crate**, so its release ships exactly one thing: the
crate on crates.io (`cargo publish`, manual). The GitHub release is just notes
(the changelog section) — there are no binaries to build or attach. The
workspace's binary crates, `revolutx-cli` and `revolutx-mcp`, are likewise
published to crates.io as source (`cargo install` builds them), so they have no
prebuilt assets either.

This repo is a **workspace**: `revolutx-cli` and `revolutx-mcp` (and any future
`revolutx-*`) depend on `revolutx`. Releasing `revolutx` has a knock-on effect on
their version requirements — see
[Workspace dependencies](#workspace-dependencies) before you publish.

## Pre-flight

0. Be on `master`, up to date, with a clean working tree and CI green on the last
   commit. Make sure you're authenticated to crates.io (`cargo login`, or
   `CARGO_REGISTRY_TOKEN` set) — otherwise the final publish fails after all the
   work. The OpenAPI submodule must be initialized (`git submodule update --init`)
   so the spec-backed tests can run.

## Review what's shipping

1. Check what has changed since the last release: `git log v0.2.0..HEAD`
   (substitute the actual previous tag).
2. Check the files that changed: `git diff v0.2.0..HEAD --name-status`.
3. Read the changed Rust files in full and make sure:
   - a) all doc comments and code comments are correct and precise;
   - b) every public item is documented and the docs match the real API;
   - c) `docs/openapi-inventory.md` and `tests/spec_coverage.rs` still match the
     spec (the coverage test fails if they drift).
4. **Groom the user-facing docs and examples** so they reflect this release:
   - a) the root `README.md` (and `cli/README.md`, `mcp/README.md`) cover **all**
     current functionality — every Cargo feature, every endpoint group, and any
     capability shipped since the last release — with nothing stale;
   - b) bump the version references to the version you're releasing: the
     `revolutx = "X.Y"` install snippets and the MSRV note in `README.md`. The
     `cargo build` gate in [Validate](#validate) catches code that stops
     compiling, but **not** a doc that still advertises an old version;
   - c) the runnable examples in `examples/` exercise the current API, and a new
     public capability worth showing has an example (they must also compile —
     `cargo build --examples`, run below).
5. **Look for opportunities to improve the code** — abstractions that can be
   simplified, code that can be made more readable, duplication that can be
   removed. THIS IS REALLY IMPORTANT. Ask a human if you have ideas you are not
   certain about. Commit and re-test any changes you make here before continuing.

## Validate

6. Make the full gate pass cleanly (and commit any fixes). These mirror CI; the
   `--workspace` flags matter because the binary crates (`revolutx-cli`,
   `revolutx-mcp`) live here too and must build/lint/test as well:
   ```bash
   cargo fmt --all --check
   cargo clippy --workspace --all-targets --all-features -- -D warnings
   cargo test --workspace --all-features
   RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --all-features
   cargo build --examples            # the public examples must compile
   ```
   Also keep the optional-feature tree clean (mirrors CI's feature matrix — this
   is what catches a feature accidentally pulling a default-on dependency, or
   non-default code that fails to compile in isolation):
   ```bash
   cargo clippy -p revolutx --no-default-features -- -D warnings               # models only
   cargo clippy -p revolutx --no-default-features --features fix -- -D warnings
   cargo clippy -p revolutx --no-default-features --features agent --all-targets -- -D warnings
   ```
   The default test suite is offline and deterministic. Do **not** run the
   ignored live smoke tests as part of a release (they need real credentials and
   hit the network); they are not a release gate.

## Update the changelog

7. Update `CHANGELOG.md` at the repo root ([Keep a Changelog](https://keepachangelog.com/)
   format). From the `git log` review above, turn the `[Unreleased]` section into
   a dated version section, grouping notable changes under
   `Added` / `Changed` / `Fixed` / `Removed`. Keep it human-readable — summarize
   what users care about, not raw commit subjects. This section is the single
   source of truth for the GitHub release notes in the last step.
   ```markdown
   ## [0.3.0] - 2026-07-01
   ### Changed
   - Credential vault moved to rcypher 0.3's `SecretStore` format (multi-factor;
     FIDO2); …
   ```
   (`CHANGELOG.md` ships in the published crate — `exclude` only drops the
   submodule, dev-only files, and the two submodule-dependent test files.)

## Bump and verify the artifact

8. Decide the new version from the review above (pre-1.0 semver: breaking changes
   bump the **minor**, features/fixes bump the **patch**). Set `version` in the
   root `Cargo.toml` (the `revolutx` crate), then run `cargo build` so
   `Cargo.lock` picks up the new `revolutx` version. Then check the dependent
   crates — see [Workspace dependencies](#workspace-dependencies) below.
9. Commit the bump and changelog first (so the tree is clean), then verify the
   package without `--allow-dirty` (which would validate a tarball containing
   uncommitted changes you'll never tag):
   ```bash
   cargo package --list          # eyeball the included files
   cargo publish --dry-run       # builds the package in isolation; submodule is excluded
   ```
   `cargo package --list` must show only intended files — no `revolut-openapi/`,
   no `.taska/`, no `.github/`. The verify build compiles the lib only and does
   not need the submodule.

## Workspace dependencies

The crates in this workspace depend on `revolutx` by **both** `path` and
`version` — e.g. `revolutx-mcp` has:

```toml
revolutx = { path = "..", version = "0.2", features = ["rest", "agent"] }
```

The `path` is only used for local/workspace builds; the **`version` requirement
is what gets enforced once the crate is published** (cargo strips the `path` on
publish). So every time you release `revolutx`, you must check each crate that
depends on it and update it deliberately — these requirements do **not** update
themselves:

1. Decide whether the dependent relies on anything introduced in *this* release.
2. If it does, bump that crate's `revolutx` `version` requirement to the version
   you're releasing, and publish the dependent **after** `revolutx` is live
   (dependency before dependents). A requirement that's too loose (e.g. `"0.2"`
   when the dependent now needs `0.3` APIs) would let the *published* dependent
   resolve against an older `revolutx` it cannot actually compile against — a
   broken `cargo install`.
3. If it doesn't, leave the requirement, but confirm it still resolves.

The next `revolutx` version is **not predetermined** — it might be a patch
(`0.2.1`) or a minor (`0.3.0`) depending on what's shipping — so bump the
dependents to whatever you actually choose here, never an assumed number.

> **Current example:** both binary crates pin `revolutx = "0.2"`, but on `master`
> they already build on `revolutx` APIs introduced *after* 0.2.0 — `revolutx-cli`
> on the rcypher-0.3 `SecretStore` keystore, `revolutx-mcp` on the agent's auth
> handshake. So the next `revolutx` release that ships those APIs (a 0.3.0)
> requires bumping each binary's `version` requirement from `"0.2"` to that
> release before it can be published; a stale `"0.2"` requirement would let a
> published binary resolve against a `revolutx` that cannot compile it (a broken
> `cargo install`).

## Commit, tag, push

10. Commit the bump and changelog as the release commit:
   ```bash
   git add Cargo.toml Cargo.lock CHANGELOG.md
   git commit -F- <<'MSG'
   Release v0.3.0
   MSG
   ```
11. Tag **that** commit so the tag and the published version agree:
    ```bash
    git tag v0.3.0
    ```
12. Push the commit and the tag:
    ```bash
    git push origin master
    git push origin v0.3.0
    ```

## Publish

13. Publish from the clean, tagged tree:
    ```bash
    cargo publish
    ```
    Then confirm it on <https://crates.io/crates/revolutx> and that docs build at
    <https://docs.rs/revolutx>.

## Create the GitHub release

14. Create a GitHub release for the tag, using the new `CHANGELOG.md` section as
    the notes. Write that section to a **temporary** scratch file at
    `docs/release-notes-v0.3.0.md` — `docs/` is fine for scratch, but **never
    commit it, and delete it as soon as the release exists**. Preferred
    (automated, via the `gh` CLI):
    ```bash
    gh release create v0.3.0 --title "v0.3.0" --notes-file docs/release-notes-v0.3.0.md
    rm docs/release-notes-v0.3.0.md   # done with it — remove, don't commit
    ```
    If you'd rather have GitHub draft the notes from merged commits/PRs instead,
    use `--generate-notes` (no scratch file needed). If `gh` is unavailable or
    unauthenticated, create it manually: GitHub → **Releases** → **Draft a new
    release** → choose the existing `v0.3.0` tag → paste the changelog section →
    **Publish release**, then delete the scratch file.

    There are no binary assets to attach: `revolutx` is a library, and the crate
    itself lives on crates.io.