211 #321
Merged
211 #321
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mples Created examples/ directory with real-world service examples demonstrating masterror integration with popular frameworks: - axum-rest-api: Full REST API with RFC 7807 Problem Details, domain errors, metadata attachment, and 11 integration tests - sqlx-database: Database error handling patterns including connection errors, constraint violations, and transactions - custom-domain-errors: Payment processing domain with derive macro usage, showcasing authentication, validation, and external service errors - basic-async: Async error handling with tokio, timeout conversion, and error propagation patterns All examples include: - Comprehensive README.md documentation - Runnable source code with cargo run - Integration tests where applicable - SPDX license headers - publish = false in Cargo.toml Updated: - examples/README.md: Index of all examples with running instructions - README.template.md: Added Examples section with table - README.md: Regenerated from template - Cargo.toml: Added 4 examples as workspace members Closes #211
Added cargo deny check to pre-commit hook to catch license issues locally before CI. This prevents CI failures like the Unicode-3.0 license issue. Changes: - Added cargo deny check (advisories, bans, licenses, sources) to pre-commit - Created .github/scripts/pre-commit (version-controlled hook) - Created .github/scripts/install-hooks.sh (automated installation) - Updated deny.toml to allow OSI-approved licenses: - Unicode-3.0 (ICU dependencies) - BSD-3-Clause (encoding_rs, matchit) - Zlib (foldhash) Pre-commit now runs all CI checks locally: - rustfmt (nightly) - REUSE compliance - clippy (all features, all targets) - tests (all features) - cargo audit - cargo deny (NEW) - catches license issues before CI - README.md generation This significantly reduces CI failures by catching issues locally.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Created comprehensive examples directory with 4 real-world service examples demonstrating masterror integration with popular frameworks.
Changes
New Directory Structure
examples/README.md - Index of all examples with running instructions
examples/axum-rest-api/ - REST API with RFC 7807 Problem Details
examples/sqlx-database/ - Database error handling with SQLx
examples/custom-domain-errors/ - Payment processing domain errors
examples/basic-async/ - Async error handling with tokio
Key Features
publish = falseto prevent crates.io publicationTest Coverage
Verification
cargo build -p axum-rest-api- Successcargo test -p axum-rest-api --tests- 11 tests passedcargo run -p <example>- All examples run successfullycargo +nightly fmt --all- All code formattedcargo test --workspace --lib- All tests passreuse lint- Full compliance (247/247 files)Closes #211