From dcdc167e186cd387c74795eabf2e9874933e0596 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 17 Aug 2021 11:19:17 +0100 Subject: [PATCH 1/3] Make a note to leave a summary on why one is bumping the schema version --- synapse/storage/schema/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/synapse/storage/schema/__init__.py b/synapse/storage/schema/__init__.py index fd4dd67d910a..dcc3ddea70fa 100644 --- a/synapse/storage/schema/__init__.py +++ b/synapse/storage/schema/__init__.py @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. +# When updating this value, please leave a short summary of the changes below. SCHEMA_VERSION = 62 """Represents the expectations made by the codebase about the database schema From f0dff5078465f8e1ab1d328c19beaba0916a49d1 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 17 Aug 2021 11:25:10 +0100 Subject: [PATCH 2/3] changelog --- changelog.d/10621.misc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/10621.misc diff --git a/changelog.d/10621.misc b/changelog.d/10621.misc new file mode 100644 index 000000000000..b8de2e1911af --- /dev/null +++ b/changelog.d/10621.misc @@ -0,0 +1 @@ +Add a comment asking developers to leave a reason when bumping the database schema version. \ No newline at end of file From 41d1b6bc591018f258a317b5c307a83e2911c8e5 Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Tue, 17 Aug 2021 12:34:30 +0100 Subject: [PATCH 3/3] generalise the wording to include schema compat version --- synapse/storage/schema/__init__.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/synapse/storage/schema/__init__.py b/synapse/storage/schema/__init__.py index dcc3ddea70fa..0cdf7ea6de3d 100644 --- a/synapse/storage/schema/__init__.py +++ b/synapse/storage/schema/__init__.py @@ -12,7 +12,8 @@ # See the License for the specific language governing permissions and # limitations under the License. -# When updating this value, please leave a short summary of the changes below. +# When updating these values, please leave a short summary of the changes below. + SCHEMA_VERSION = 62 """Represents the expectations made by the codebase about the database schema