Resolve "Require a changelog entry for all [feature flag] changes"
What does this MR do?
TL:DR, closing this MR, as it's superseded by:
- !53393 (merged) to make sure there's a changelog whenever a feature flag is removed
- #301090, to make sure that docs are consistent with the current state of feature flags
Whenever a feature flag is added, changed, or removed, customers want to know about the change.
As described in https://gitlab.zendesk.com/agent/tickets/184939 (internal access only), we have a customer who
- Was surprised by the removal of a feature flag
- Looked through the changelog, and so no related notification
- Asked us to create notifications to prevent such surprises in the future
Customers should be able to search our changelog for feature flag changes. Ideally, the feature flag changelog message will include:
- Change in feature flag (added, modified, removed)
- Feature flag topic
- Related MR (which would then include a link to relevant documentation)
To ensure that changelog entries are added for all feature flag changes, we should revise https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry to:
- Require a changelog entry for all feature flag changes
Since many feature flag changes are implemented later as "docs-only" changes, modify the "docs-only" bullet to include something like:
- "Docs-only changes that affect feature flags must have a changelog entry, unless one was created in a previous MR."
Screenshots (strongly suggested)
Does this MR meet the acceptance criteria?
Conformity
-
Changelog entry -
Documentation (if required) -
Code review guidelines -
Merge request performance guidelines -
Style guides -
Database guides -
Separation of EE specific content
Availability and Testing
-
Review and add/update tests for this feature/bug. Consider all test levels. See the Test Planning Process. -
Tested in all supported browsers -
Informed Infrastructure department of a default or new setting change, if applicable per definition of done
Security
If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:
-
Label as security and @ mention @gitlab-com/gl-security/appsec -
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Related to #299337 (closed)