Make a note to leave a summary when one is bumping the schema version (…

…#10621) I found this easy to miss (and evidently, it looks like it was missed for schema version 62).
matrix-org · Aug 25, 2021 · b45cc15 · b45cc15
1 parent 882539e
commit b45cc15
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/changelog.d/10621.misc b/changelog.d/10621.misc
@@ -0,0 +1 @@
+Add a comment asking developers to leave a reason when bumping the database schema version.
diff --git a/synapse/storage/schema/__init__.py b/synapse/storage/schema/__init__.py
@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# When updating these values, please leave a short summary of the changes below.
+
 SCHEMA_VERSION = 63
 """Represents the expectations made by the codebase about the database schema
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add a comment asking developers to leave a reason when bumping the database schema version.