Versioning and release
Versioning and release discipline are critical to ensuring predictability for clients and interoperability across the Lerian ecosystem. All plugins must follow the same versioning rules and align with Lerian’s official release cycle.
Versioning
All plugins must use Semantic Versioning 2.0.0.- MAJOR: incompatible API or behavior changes.
- MINOR: backward-compatible feature additions.
- PATCH: backward-compatible bug fixes.
Check our simplified Versioning page for practical examples.
Release cycle
All plugin releases must align with Lerian’s official release calendar. This ensures predictability and smooth upgrades for shared clients.- Internal development workflows remain independent
- Public releases must follow the Lerian cycle
- Patch versions for hotfixes or critical updates may be released outside the cycle
Misaligned releases may be rejected from publication in the Lerian Marketplace.
Technical documentation
Clear, consistent documentation is mandatory for every plugin in the Lerian ecosystem. Your clients depend on it to adopt, integrate, and operate your solution effectively. All official plugin documentation must be hosted on the Lerian Documentation Hub to ensure a unified experience.
Required documentation
Every plugin must provide at least:- Guides: for business rules, setup, and usage.
- API Reference: for all exposed endpoints, and technical documentation.
You may still host your own documentation, but clients must be redirected to the official Lerian site for authoritative technical content.
Standards and templates
To guarantee consistency and usability, all documentation must follow the Lerian Writing Standards.Why this matters
Great documentation is a compliance requirement, not a nice-to-have. It reduces onboarding friction, prevents misuse, and keeps client support efficient.Plugins without proper documentation will not be approved for publication.
Approval process
Before a plugin can be published on the Lerian Marketplace, it must pass a strict homologation process. This ensures that every solution meets Lerian’s standards for quality, security, and compliance.
Plugins that fail any of these checks will not be approved for publication. All identified issues must be resolved before resubmission.
Homologation requirements
Before being published, all plugins must pass a formal review, which includes:- Technical checklist – architecture, coding standards, observability, and API compliance.
- Security checklist – pentests, audits, and data protection controls.
- Quality & performance checks – test coverage, scalability, and stress test reports.
- Regulatory compliance review – verification against BACEN and other governing bodies.
- End-to-end testing – validation with Midaz or other Lerian solutions to confirm interoperability.
Severity-based SLAs
If your plugin is distributed under a support agreement where you, as the development partner, are responsible for maintenance, you must follow Lerian’s severity-based SLA guidelines. These rules ensure timely resolution of issues and a consistent experience for clients across the ecosystem.
Why this matters
Meeting SLAs reinforces trust in the Lerian ecosystem. Clients can rely on predictable response times, while partners demonstrate accountability and professionalism in supporting their solutions.Resolution timelines
These SLAs define the maximum time allowed to deliver a fix, based on the severity of the reported issue:| Severity | Required resolution time |
|---|---|
| High | Fix within 5 business days |
| Medium | Fix within 10 business days |
| Low | Fix within 30 business days |
Timelines refer to business days and apply from the moment the issue is confirmed.These SLAs are mandatory for all partner-supported plugins.