ci(docs): add contract event documentation drift validator (#714) - #738
Open
ravendevhub wants to merge 1 commit into
Open
ci(docs): add contract event documentation drift validator (#714)#738ravendevhub wants to merge 1 commit into
ravendevhub wants to merge 1 commit into
Conversation
…dry#714) - Create scripts/validate-contract-events.py extracting contractevent structs and cross-referencing docs - Catalog all 34 public Soroban contract events in docs/CONTRACT_EVENTS.md - Add GitHub Actions CI workflow to detect event documentation drift on PRs
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
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
Resolves #714 by introducing an automated documentation drift checker (
scripts/validate-contract-events.py) and comprehensive event catalog (docs/CONTRACT_EVENTS.md) that parses Rust source files to ensure all 34 public Soroban contract events and their topics/data payloads remain synchronized with documentation.Changes
scripts/validate-contract-events.py):contract/contracts/hello-world/src/base/events.rsfor#[contractevent]struct definitions.docs/CONTRACT_EVENTS.md):.github/workflows/validate-contract-events.yml):Acceptance Criteria