Skip to content

Commit a50771a

Browse files
authored
[14/n] add an example with Git stub materialization (#63)
Shows how to use a build script to materialize a Git stub.
1 parent 6322be4 commit a50771a

11 files changed

Lines changed: 691 additions & 48 deletions

File tree

.github/workflows/ci.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ jobs:
1717
RUSTFLAGS: -D warnings
1818
steps:
1919
- uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1
20+
with:
21+
# We need to fetch the entire history so clippy can run the
22+
# e2e-example/client build script.
23+
fetch-depth: 0
2024
- uses: dtolnay/rust-toolchain@stable
2125
with:
2226
components: rustfmt, clippy

AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ Problems are either **fixable** (tool can auto-correct) or **unfixable** (requir
195195

196196
1. **Three-way reconciliation**—blessed, generated, and local sources are compared to detect drift and ensure compatibility.
197197

198-
2. **Wire compatibility checking**—uses the `drift` crate to semantically compare OpenAPI specs. Trivial changes (doc updates, type renames) are allowed in blessed versions; semantic changes (forward compatible, backwards compatible, or incompatible) are not.
198+
2. **Wire compatibility checking**—uses the `drift` crate to semantically compare OpenAPI documents. Trivial changes (doc updates, type renames) are allowed in blessed versions; semantic changes (forward compatible, backwards compatible, or incompatible) are not.
199199

200200
3. **Atomic file operations**—uses `atomicwrites` crate to prevent corruption on interruption.
201201

@@ -255,8 +255,8 @@ crates/
255255
### Key dependencies
256256

257257
- **dropshot**: Dropshot HTTP framework and API description generation.
258-
- **openapiv3**: OpenAPI spec parsing and representation.
259-
- **drift**: Semantic diff of OpenAPI specs for compatibility checking.
258+
- **openapiv3**: OpenAPI document parsing and representation.
259+
- **drift**: Semantic diff of OpenAPI documents for compatibility checking.
260260
- **thiserror**: Error derive macros.
261261
- **anyhow**: Error handling and context.
262262
- **camino**: UTF-8 paths (`Utf8PathBuf`).
@@ -269,7 +269,7 @@ crates/
269269
- **owo-colors**: Colored terminal output.
270270
- **similar**: Diff generation for display.
271271
- **supports-color**: Terminal color capability detection.
272-
- **openapi-lint**: Custom linting for OpenAPI specs.
272+
- **openapi-lint**: Custom linting for OpenAPI documents.
273273

274274
## Quick reference
275275

0 commit comments

Comments
 (0)