IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-22 08:56:43 -06:00
Code Issues Packages Projects Releases Wiki Activity
b2cb8d8038
grafana/contribute/feature-toggles.md
Eric Leijonmarck 7794697660
Doc: Add docs for direct mapping of None role for SAML (#76551) 
* add: direct mapping of None role for SAML

* Fix docs formatting

* fix spelling

---------

Co-authored-by: Vardan Torosyan <vardants@gmail.com>
2023-10-13 16:01:55 +01:00

1.5 KiB
Raw Blame History

Feature toggle guide

This guide helps you get started adding your feature behind a feature flag in Grafana.

Steps to adding a feature toggle

  1. Define the feature toggle in registry.go. To see what each feature stage means, look at the comments here. If you are a community member, use the CODEOWNERS file to determine which team owns the package you are updating.
  2. Run the go tests mentioned at the top of this file. This will generate all the additional files needed: toggles_gen for the backend, grafana-data for the frontend, and docs. You can run the test by running go test ./pkg/services/featuremgmt/.... This will say the tests failed the first time, but it will have generated the right code. If you re-run the tests, it will pass.

How to use it in the code

Once your feature toggle is defined, you can then wrap your feature around a check if the feature flag is enabled on that Grafana instance. Here are examples of how to do that:

  • Backend: Use the IsEnabled function and pass in your feature toggle.
  • Frontend: Check the config for your feature toggle.