Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Make a note to leave a summary when one is bumping the schema version #10621

Merged
merged 4 commits into from
Aug 25, 2021
Merged

Make a note to leave a summary when one is bumping the schema version #10621

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dcdc167
Make a note to leave a summary on why one is bumping the schema version
anoadragon453 Aug 17, 2021
f0dff50
changelog
anoadragon453 Aug 17, 2021
41d1b6b
generalise the wording to include schema compat version
anoadragon453 Aug 17, 2021
3c03ba9
Merge branch 'develop' of github.com:matrix-org/synapse into anoa/sch…
anoadragon453 Aug 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/10621.misc
View file
Open in desktop
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.
1 change: 1 addition & 0 deletions synapse/storage/schema/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, should we be asking the same for SCHEMA_COMPAT_VERSION perhaps?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't really think so. it's somewhat obvious?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same could be said about this value 😛

I might just tweak the wording slightly to apply to both values.

SCHEMA_VERSION = 62
"""Represents the expectations made by the codebase about the database schema

Expand Down