Docs: Ensure documented feature flags are up-to-date with their current states
The problem
Documented user-facing features behind feature flags are not always updated when the feature flag state is changed.
The solution
Discussion from the FF working group:
Implement a test to check that, if the feature flag is documented and its state is changed, the MR must include an update to the documentation. The idea is to check the feature flag name this_feature_flag
against the docs to make sure documented FFs are consistent and kept up-to-date with the state of the feature flag.
Example
- Consider a feature called "Feature A" was deployed behind a feature flag disabled by default
feature_a
. - The FF was documented in the docs according to the "disabled-by-default" template.
- Consider that the FF state was changed to "enabled by default" and the dev who made the change forgot to update the docs according to the "became-enabled-by-default" template.
- Currently: nothing happens.
-
Proposal: a Dangerbot test will check for the mention of
feature a
in the docs and the pipeline will fail if the docs are not updated.
@ayufan please double-check this description to see if I understood this right?
Edited by Marcia Ramos