Add build kind to main window titles for unstable/dev/preview releases

bonsai-rx · Jul 4, 2024 · 1822ed8 · 1822ed8
1 parent aacd46d
commit 1822ed8
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 2 deletions.
diff --git a/Bonsai.Editor/AboutBox.cs b/Bonsai.Editor/AboutBox.cs
@@ -11,14 +11,32 @@ partial class AboutBox : Form
         public AboutBox()
         {
             InitializeComponent();
-            this.Text = String.Format("About {0}", AssemblyTitle);
+            this.Text = $"About {AssemblyTitle}{BuildKindTitleSuffix}";
             this.labelProductName.Text = AssemblyProduct;
-            this.labelVersion.Text = String.Format("Version {0}", AssemblyVersion);
+            this.labelVersion.Text = $"Version {AssemblyVersion}";
             this.labelCopyright.Text = AssemblyCopyright;
             this.labelCompanyName.Text = AssemblyCompany;
             this.textBoxDescription.Text = AssemblyDescription + Environment.NewLine + Resources.AttributionNotices;
         }
 
+        internal static string BuildKindTitleSuffix
+        {
+            get
+            {
+#if BUILD_KIND_DEV
+                return " [Dev]";
+#elif BUILD_KIND_UNSTABLE
+                return " [Unstable]";
+#elif BUILD_KIND_PREVIEW
+                return " [Preview]";
+#elif BUILD_KIND_OFFICIAL_RELEASE
+                return "";
+#else
+#error "Unknown build kind!"
+#endif
+            }
+        }
+
         #region Assembly Attribute Accessors
 
         public string AssemblyTitle

diff --git a/Bonsai.Editor/EditorForm.cs b/Bonsai.Editor/EditorForm.cs
@@ -187,6 +187,8 @@ public EditorForm(
                 editorControl.Leave += delegate { menuStrip.Enabled = true; };
             }
             components.Add(editorControl);
+
+            UpdateTitle();
         }
 
         #region Loading
@@ -1473,6 +1475,7 @@ void UpdateTitle()
             if (modified) title.Append('*');
             if (workflowRunning) title.AppendFormat(" ({0})", Resources.RunningStatus);
             if (!emptyFileName) title.AppendFormat(" - {0}", Resources.BonsaiTitle);
+            title.Append(AboutBox.BuildKindTitleSuffix);
             Text = title.ToString();
         }
 

diff --git a/Bonsai.Editor/StartScreen.cs b/Bonsai.Editor/StartScreen.cs
@@ -36,6 +36,7 @@ public StartScreen()
             openTreeView.Nodes.Add(galleryNode);
             openTreeView.Nodes.Add(packageManagerNode);
             FileName = string.Empty;
+            Text += AboutBox.BuildKindTitleSuffix;
         }
 
         public EditorResult EditorResult { get; private set; }

diff --git a/tooling/Versioning.props b/tooling/Versioning.props
@@ -7,15 +7,23 @@
 
     <Version>$(BonsaiVersion)-dev$(DevVersion)</Version>
     <_FileVersionRevision>$([MSBuild]::Add(60000, $(DevVersion)))</_FileVersionRevision>
+    <BuildKindConstant>BUILD_KIND_DEV</BuildKindConstant>
   </PropertyGroup>
   <PropertyGroup Condition="'$(ContinuousIntegrationBuild)' == 'true'">
     <Version>$(BonsaiVersion)$(CiBuildVersionSuffix)</Version>
     <Version Condition="'$(CiBuildVersion)' != ''">$(CiBuildVersion)</Version>
     <_FileVersionRevision>0</_FileVersionRevision>
     <_FileVersionRevision Condition="'$(CiIsForRelease)' != 'true' and '$(CiRunNumber)' != ''">$(CiRunNumber)</_FileVersionRevision>
+
+    <BuildKindConstant Condition="'$(CiIsForRelease)' != 'true'">BUILD_KIND_UNSTABLE</BuildKindConstant>
+    <BuildKindConstant Condition="'$(CiIsForRelease)' == 'true'">BUILD_KIND_OFFICIAL_RELEASE</BuildKindConstant>
+    <BuildKindConstant Condition="'$(CiIsForRelease)' == 'true' and $(Version.Contains('-'))">BUILD_KIND_PREVIEW</BuildKindConstant>
   </PropertyGroup>
 
   <PropertyGroup>
+    <BuildKindConstant Condition="'$(BuildKindConstant)' == ''">BUILD_KIND_UNKNOWN</BuildKindConstant>
+    <DefineConstants>$(DefineConstants);$(BuildKindConstant)</DefineConstants>
+
     <!-- Force malformed versions to be an error -->
     <WarningsAsErrors>$(WarningsAsErrors);CS7035</WarningsAsErrors>
   </PropertyGroup>