Document locking of markdown cache version

778aac63 · John Hope · Patrick Bajao · c2a59e01 · 778aac63
Commit 778aac63 authored May 12, 2021 by John Hope Committed by Patrick Bajao May 12, 2021
Hide whitespace changes
Inline Side-by-side

Showing with 5 additions and 1 deletion

lib/gitlab/markdown_cache.rb lib/gitlab/markdown_cache.rb +5 -1

No files found.
--- a/lib/gitlab/markdown_cache.rb
+++ b/lib/gitlab/markdown_cache.rb
@@ -2,7 +2,11 @@
 module Gitlab
  module MarkdownCache
-    # Increment this number every time the renderer changes its output
+    # Increment this number every time the renderer changes its output.
+    # Changing this value puts strain on the database, as every row with
+    # cached markdown needs to be updated. As a result, this line should
+    # not be changed.
+    # See: https://gitlab.com/gitlab-org/gitlab/-/issues/330313
    CACHE_COMMONMARK_VERSION        = 28
    CACHE_COMMONMARK_VERSION_START  = 10