Skip to content

Commit 7be21da

Browse files
doc2readme: add --workspace + regenerate READMEs
cargo doc2readme requires either being run from a single-crate directory or being told to walk the workspace. Our recipe was running it from the workspace root without --workspace, so it failed in CI with 'Missing package. Please make sure there is a package here, or enable workspace support with --workspace.' Add --workspace. Also regenerated the four crate READMEs that were out of date (automation, cargo_ensure_no_cyclic_deps, cargo_heather, cargo_ox_check) so the --check pass goes green. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent f9507be commit 7be21da

9 files changed

Lines changed: 4157 additions & 72 deletions

File tree

crates/automation/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# Automation
2-
3-
[![CI](https://github.com/microsoft/ox-tools/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/microsoft/ox-tools/actions/workflows/main.yml)
4-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](../../LICENSE)
1+
# automation ![License: MIT](https://img.shields.io/badge/license-MIT-blue) [![automation on crates.io](https://img.shields.io/crates/v/automation)](https://crates.io/crates/automation) [![automation on docs.rs](https://docs.rs/automation/badge.svg)](https://docs.rs/automation) [![Rust Version: 1.88.0](https://img.shields.io/badge/rustc-1.88.0-orange.svg)](https://github.com/rust-lang/rust/releases/tag/1.88.0)
52

63
An unpublished crate for shared code used for writing Rust scripts
7-
8-
<hr/>
9-
<sub>
10-
This crate was developed as part of <a href="../..">The Oxidizer Project</a>.
11-
</sub>

crates/cargo_ensure_no_cyclic_deps/README.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
1-
<div align="center">
2-
<img src="./logo.png" alt="Cargo-Ensure-No-Cyclic-Deps Logo" width="96">
3-
4-
# Cargo-Ensure-No-Cyclic-Deps
5-
6-
[![crate.io](https://img.shields.io/crates/v/cargo-ensure-no-cyclic-deps.svg)](https://crates.io/crates/cargo-ensure-no-cyclic-deps)
7-
[![docs.rs](https://docs.rs/cargo-ensure-no-cyclic-deps/badge.svg)](https://docs.rs/cargo-ensure-no-cyclic-deps)
8-
[![MSRV](https://img.shields.io/crates/msrv/cargo-ensure-no-cyclic-deps)](https://crates.io/crates/cargo-ensure-no-cyclic-deps)
9-
[![CI](https://github.com/microsoft/ox-tools/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/microsoft/ox-tools/actions/workflows/main.yml)
10-
[![Coverage](https://codecov.io/gh/microsoft/ox-tools/graph/badge.svg?token=FCUG0EL5TI)](https://codecov.io/gh/microsoft/ox-tools)
11-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](../../LICENSE)
12-
<a href="../.."><img src="../../logo.svg" alt="This crate was developed as part of the Oxidizer project" width="20"></a>
13-
14-
</div>
1+
# cargo-ensure-no-cyclic-deps ![License: MIT](https://img.shields.io/badge/license-MIT-blue) [![cargo-ensure-no-cyclic-deps on crates.io](https://img.shields.io/crates/v/cargo-ensure-no-cyclic-deps)](https://crates.io/crates/cargo-ensure-no-cyclic-deps) [![cargo-ensure-no-cyclic-deps on docs.rs](https://docs.rs/cargo-ensure-no-cyclic-deps/badge.svg)](https://docs.rs/cargo-ensure-no-cyclic-deps) [![Source Code Repository](https://img.shields.io/badge/Code-On%20GitHub-blue?logo=GitHub)](https://github.com/microsoft/ox-tools/tree/main/crates/cargo-ensure-no-cyclic-deps) [![Rust Version: 1.88.0](https://img.shields.io/badge/rustc-1.88.0-orange.svg)](https://github.com/rust-lang/rust/releases/tag/1.88.0)
152

163
A cargo sub-command that detects cyclic dependencies between crates in a workspace. This is useful if you
174
want to prevent dev-dependencies from creating dependency cycles as that can cause issues,
@@ -67,9 +54,4 @@ No cyclic dependencies found.
6754
The tool will exit with code 0 if no cycles are found, or code 1 if cycles are detected.
6855

6956

70-
<hr/>
71-
<sub>
72-
This crate was developed as part of <a href="../..">The Oxidizer Project</a>. Browse this crate's <a href="https://github.com/microsoft/ox-tools/tree/main/crates/cargo-ensure-no-cyclic-deps">source code</a>.
73-
</sub>
74-
7557
[__link0]: https://github.com/crate-ci/cargo-release

crates/cargo_heather/README.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
1-
<div align="center">
2-
<img src="./logo.png" alt="Cargo Heather Logo" width="96">
3-
4-
# Cargo Heather
5-
6-
[![crate.io](https://img.shields.io/crates/v/cargo_heather.svg)](https://crates.io/crates/cargo_heather)
7-
[![docs.rs](https://docs.rs/cargo_heather/badge.svg)](https://docs.rs/cargo_heather)
8-
[![MSRV](https://img.shields.io/crates/msrv/cargo_heather)](https://crates.io/crates/cargo_heather)
9-
[![CI](https://github.com/microsoft/ox-tools/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/microsoft/ox-tools/actions/workflows/main.yml)
10-
[![Coverage](https://codecov.io/gh/microsoft/ox-tools/graph/badge.svg?token=FCUG0EL5TI)](https://codecov.io/gh/microsoft/ox-tools)
11-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](../../LICENSE)
12-
<a href="../.."><img src="../../logo.svg" alt="This crate was developed as part of the Oxidizer project" width="20"></a>
13-
14-
</div>
1+
# cargo_heather ![License: MIT](https://img.shields.io/badge/license-MIT-blue) [![cargo_heather on crates.io](https://img.shields.io/crates/v/cargo_heather)](https://crates.io/crates/cargo_heather) [![cargo_heather on docs.rs](https://docs.rs/cargo_heather/badge.svg)](https://docs.rs/cargo_heather) [![Source Code Repository](https://img.shields.io/badge/Code-On%20GitHub-blue?logo=GitHub)](https://github.com/microsoft/ox-tools/tree/main/crates/cargo_heather) [![Rust Version: 1.88.0](https://img.shields.io/badge/rustc-1.88.0-orange.svg)](https://github.com/rust-lang/rust/releases/tag/1.88.0)
152

163
## cargo-heather
174

@@ -107,10 +94,3 @@ Fixed 2 file(s).
10794
1. **File scanning** — Walks the project directory to find all `.rs` and `.toml` files, skipping `target/`, hidden directories, and the config file itself.
10895
1. **Header validation** — Extracts the first comment block from each file (`//` for Rust, `#` for TOML) and compares it to the expected header. Reports missing or mismatched headers.
10996
1. **Fix mode** — When `--fix` is passed, automatically prepends the correct header to files that are missing it, or replaces incorrect headers.
110-
111-
112-
<hr/>
113-
<sub>
114-
This crate was developed as part of <a href="../..">The Oxidizer Project</a>. Browse this crate's <a href="https://github.com/microsoft/ox-tools/tree/main/crates/cargo_heather">source code</a>.
115-
</sub>
116-

crates/cargo_ox_check/README.md

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,4 @@
1-
<div align="center">
2-
<img src="./logo.png" alt="Cargo-Ox-Check Logo" width="96">
3-
4-
# Cargo-Ox-Check
5-
6-
[![crate.io](https://img.shields.io/crates/v/cargo-ox-check.svg)](https://crates.io/crates/cargo-ox-check)
7-
[![docs.rs](https://docs.rs/cargo-ox-check/badge.svg)](https://docs.rs/cargo-ox-check)
8-
[![MSRV](https://img.shields.io/crates/msrv/cargo-ox-check)](https://crates.io/crates/cargo-ox-check)
9-
[![CI](https://github.com/microsoft/ox-tools/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/microsoft/ox-tools/actions/workflows/main.yml)
10-
[![Coverage](https://codecov.io/gh/microsoft/ox-tools/graph/badge.svg?token=FCUG0EL5TI)](https://codecov.io/gh/microsoft/ox-tools)
11-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](../../LICENSE)
12-
<a href="../.."><img src="../../logo.svg" alt="This crate was developed as part of the Oxidizer project" width="20"></a>
13-
14-
</div>
1+
# cargo-ox-check ![License: MIT](https://img.shields.io/badge/license-MIT-blue) [![cargo-ox-check on crates.io](https://img.shields.io/crates/v/cargo-ox-check)](https://crates.io/crates/cargo-ox-check) [![cargo-ox-check on docs.rs](https://docs.rs/cargo-ox-check/badge.svg)](https://docs.rs/cargo-ox-check) [![Source Code Repository](https://img.shields.io/badge/Code-On%20GitHub-blue?logo=GitHub)](https://github.com/microsoft/ox-tools/tree/main/crates/cargo_ox_check) [![Rust Version: 1.88.0](https://img.shields.io/badge/rustc-1.88.0-orange.svg)](https://github.com/rust-lang/rust/releases/tag/1.88.0)
152

163
## cargo-ox-check
174

@@ -110,10 +97,3 @@ See `docs/design/` for the full architecture:
11097
* `ado.md` — Azure DevOps Pipelines emission.
11198

11299
And `docs/verification.md` for the continuous-validation strategy.
113-
114-
115-
<hr/>
116-
<sub>
117-
This crate was developed as part of <a href="../..">The Oxidizer Project</a>. Browse this crate's <a href="https://github.com/microsoft/ox-tools/tree/main/crates/cargo-ox-check">source code</a>.
118-
</sub>
119-

crates/cargo_ox_check/templates/justfiles/ox-check/checks.just

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ ox-check-readme-check: (_ox-check-require "cargo-doc2readme")
151151
Write-Host 'ox-check-readme-check: no modified packages; skipping'
152152
exit 0
153153
}
154-
cargo doc2readme --check
154+
cargo doc2readme --check --workspace
155155
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
156156

157157
# Modified tier.

0 commit comments

Comments
 (0)