From 533f4b298f5f0a34fa690e33c11ac858cae783ee Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Wed, 11 May 2022 10:40:40 +0900
Subject: [PATCH] Add explanation inline for future visitors

---
 osu.Game/Utils/SentryLogger.cs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/osu.Game/Utils/SentryLogger.cs b/osu.Game/Utils/SentryLogger.cs
index 218d10345f..16f1a8b039 100644
--- a/osu.Game/Utils/SentryLogger.cs
+++ b/osu.Game/Utils/SentryLogger.cs
@@ -34,6 +34,8 @@ public SentryLogger(OsuGame game)
 
                 options.AutoSessionTracking = true;
                 options.IsEnvironmentUser = false;
+                // The reported release needs to match release tags on github in order for sentry
+                // to automatically associate and track against releases.
                 options.Release = game.Version.Replace($@"-{OsuGameBase.BUILD_SUFFIX}", string.Empty);
             });