docs: document CR scope, notifications and non-notification events#7549
Open
SahilJat wants to merge 1 commit into
Open
docs: document CR scope, notifications and non-notification events#7549SahilJat wants to merge 1 commit into
SahilJat wants to merge 1 commit into
Conversation
|
@SahilJat is attempting to deploy a commit to the Flagsmith Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/if required so people know about the feature.Changes
Closes #7505
The Change Requests docs page had two gaps that were causing avoidable
support conversations:
Scope was not documented — the page said "attempting to change a flag
value will prompt you to create a new Change Request" without clarifying
that identity-level overrides are intentionally excluded from the workflow
and go live immediately.
Notifications were not documented — the page mentioned assignee emails
only once in passing. The full set of emails that fire (pending-approval to
assignee, approval-granted to author, group assignment notification) was
not described anywhere. Equally important, what does not trigger a
notification (commit, deletion, webhooks) was also undocumented, leading
customers to expect behaviour that does not exist.
**Changes made **
feature state types require a CR and which do not, with an explanation of
why identity overrides are excluded (they do not participate in the
versioning system the CR workflow is built on)
approval gates on all changes
that fire during the CR lifecycle, and an explicit list of events that do
not trigger notifications (commit, deletion, webhooks)
applies to environment defaults and segment overrides, not all flag changes
Both additions are verified against the actual implementation in
api/features/workflows/core/models.py.How did you test this code?
This is a documentation-only change — no code was modified.
Verified the described behaviour against the source code:
FeatureState.typeproperty andis_liveproperty in
api/features/models.pythat identity overrides bypassversioning and are live immediately
send_email_notification_to_assignee,send_email_notification_to_author, andnotify_group_of_change_request_assignmenthooks inapi/features/workflows/core/models.pythat the documented emails are thecomplete set
flow exists, and no CR lifecycle webhook events are present in the codebase