Skip to content

Commit

Permalink
Update docusaurus/docs/get-started/best-practices.md
Browse files Browse the repository at this point in the history
Co-authored-by: Joseph Perez <[email protected]>
  • Loading branch information
sunker and josmperez authored Jan 29, 2025
1 parent 4d348ba commit f12806b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docusaurus/docs/get-started/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ To ensure robust and reliable plugins, follow these best practices:

- **Adopt the latest plugin APIs:** Using the latest plugin API versions allows developers to leverage new Grafana features and ensures alignment with the platform's evolving capabilities. It also encourages regular maintenance and updates of plugins and its dependencies.
- **Maintain a single development branch:** Aim to maintain a single branch for the entire range of Grafana versions supported by the plugin (as specified in the `grafanaDependency`). This approach reduces the maintenance burden and aligns with practices used in the Grafana plugin catalog.
- **Manage backward compatibility with runtime checks:** To utilize new Grafana features while maintaining compatibility with older versions, implement conditional logic that verifies feature availability at runtime. For guidance, see the article on [Runtime Checks](../how-to-guides/runtime-checks.md).
- **Manage backward compatibility with runtime checks:** To utilize new Grafana features while maintaining compatibility with older versions, implement conditional logic that verifies feature availability at runtime. For guidance, see [Manage backwards compatibility with runtime checks](../how-to-guides/runtime-checks.md).
<!-- Uncomment when this article is written - **Manage backward compatibility by using the compatibility packge:** -->
<!-- Uncomment when this article is written - **Manage backward compatibility by bundling `grafana/ui`:** -->
- **Perform end-to-end testing using a Grafana version matrix:** Due to Grafana’s dependency sharing mechanism, many plugin related issues only surface at runtime. Such issues can be detected easily by running end-to-end smoke tests across a matrix of Grafana versions corresponding to the range specified in the plugin's `plugin.json`. Continuously end-to-end testing the plugin not only older supported Grafana’s versions but also against main branch helps ensure backwards and forward compatibility, enabling plugin maintainers to verify functionality with upcoming Grafana releases.

0 comments on commit f12806b

Please sign in to comment.