-
Notifications
You must be signed in to change notification settings - Fork 78
Add zombienet page #1323
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: staging/product-ia
Are you sure you want to change the base?
Add zombienet page #1323
Conversation
* Introduce Zombienet as a testing framework for Polkadot SDK-based blockchain networks. * Detail installation methods including executable, Nix, and Docker. * Outline key features, configuration options, and CLI commands for network spawning and testing. * Provide examples for basic configuration and test file structure. Co-authored-by: [Your Name] <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR transforms the Zombienet documentation from a placeholder to a comprehensive reference guide. It provides detailed information about Zombienet, a testing framework for Polkadot SDK-based blockchain networks, including installation methods, provider configurations, network spawning, and test writing capabilities.
- Added complete documentation structure with installation instructions for multiple platforms (executable, Nix, Docker)
- Documented three provider options (Kubernetes, Podman, native) with requirements and features
- Included configuration examples in both TOML and JSON formats, CLI commands, and test DSL usage
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Zombienet supports different backend providers for running nodes: [Kubernetes](https://kubernetes.io/){target=\_blank}, [Podman](https://podman.io/){target=\_blank}, and native (local processes). Specify the provider using the `--provider` flag or in your network configuration file: | ||
|
|
||
| ```bash | ||
| zombienet spawn network.toml --provider INSERT_PROVIDER |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
List the different values for provider.
Co-authored-by: Bruno Galvao <[email protected]> Co-authored-by: Copilot <[email protected]>
📝 Description
This pull request adds comprehensive documentation for Zombienet in
.reference/tools/zombienet.md. The new content provides an overview of Zombienet, installation instructions, configuration details, usage examples, and links to further resources. This update transforms the file from a placeholder to a full reference guide, making it much easier for developers to understand and use Zombienet for testing Polkadot SDK-based blockchain networks.Documentation improvements:
🔍 Review Preference
Choose one:
🤖 AI-Ready Docs
If content changed, regenerate AI files:
python3 scripts/generate_llms.py✅ Checklist