From 032feffef4d17082291d5863aedb4aa9a7218d0f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=86var=20Arnfj=C3=B6r=C3=B0=20Bjarmason?= Date: Tue, 23 Mar 2021 15:33:36 +0100 Subject: WIP Feature flag rollout docs: correct OnByDefault and removal examples The change I made in 938a75444 (Feature flag rollout docs: add examples of Go/Ruby code removal, 2021-02-25) didn't make much sense. The link to the "on by default" didn't actually link to such a MR. This would be ideal, but in !3033 I made the stupid mistake of mixing up "delete" and "create" in the subject. So let's have this wait, will rewrite this once I have UserUpdateBranch landed with something more sensible I can link to as an example. --- doc/PROCESS.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/PROCESS.md b/doc/PROCESS.md index 652bc73ff..cf3f589e2 100644 --- a/doc/PROCESS.md +++ b/doc/PROCESS.md @@ -220,20 +220,21 @@ close monitoring at 50%. After a feature is running at `100%` for what ever's deemed to be a safe amount of time we should change it to be `OnByDefault: true`. See -[this MR for an example][example-on-by-default-mr]. - -We should add a changelog entry when `OnByDefault: true` is flipped. +[this MR for an example][example-on-by-default-mr]. The MR should +include a changelog entry. That should then be followed up by another MR to remove the pre-feature code from the codebase, and we should add another -changelog entry when doing that. +changelog entry when doing that. See [this MR for an +example][example-feature-code-removal-mr] This is because even after setting `OnByDefault: true` users might still have opted to disable the new feature. See [the discussion below](#two-phase-ruby-to-go-rollouts)) for possibly needing to do such changes over multiple releases. -[example-on-by-default-mr]: https://gitlab.com/gitlab-org/gitaly/-/merge_requests/3033 +[example-on-by-default-mr]: https://gitlab.com/gitlab-org/gitaly/-/merge_requests/3035 +[example-feature-code-removal-mr]: https://gitlab.com/gitlab-org/gitaly/-/merge_requests/3033 ##### Two phase Ruby to Go rollouts -- cgit v1.2.3