Add GitInfo NuGet package (#268)

In this PR, I added a NuGet package called GitInfo. It can replace Octobot.RepositoryUrl and display the bot version as the current branch and commit. --------- Signed-off-by: mctaylors <[email protected]> Signed-off-by: Macintxsh <[email protected]>
TeamOctolings · Mar 19, 2024 · 2342116 · 2342116
1 parent 771750c
commit 2342116
Show file tree

Hide file tree

Showing 10 changed files with 75 additions and 9 deletions.
diff --git a/Octobot.csproj b/Octobot.csproj
@@ -17,10 +17,12 @@
         <NeutralLanguage>en</NeutralLanguage>
         <Description>A general-purpose Discord bot for moderation written in C#</Description>
         <ApplicationIcon>docs/octobot.ico</ApplicationIcon>
+        <GitVersion>false</GitVersion>
     </PropertyGroup>
 
     <ItemGroup>
         <PackageReference Include="DiffPlex" Version="1.7.2" />
+        <PackageReference Include="GitInfo" Version="3.3.4" />
         <PackageReference Include="Humanizer.Core.ru" Version="2.14.1" />
         <PackageReference Include="JetBrains.Annotations" Version="2023.3.0" />
         <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.4" />

diff --git a/locale/Messages.resx b/locale/Messages.resx
@@ -657,6 +657,9 @@
   <data name="TimeSpanExample" xml:space="preserve">
       <value>Example of a valid input: `1h30m`</value>
   </data>
+  <data name="Version" xml:space="preserve">
+      <value>Version: {0}</value>
+  </data>
   <data name="SettingsWelcomeMessagesChannel" xml:space="preserve">
       <value>Welcome messages channel</value>
   </data>

diff --git a/locale/Messages.ru.resx b/locale/Messages.ru.resx
@@ -657,6 +657,9 @@
   <data name="TimeSpanExample" xml:space="preserve">
       <value>Пример правильного ввода: `1ч30м`</value>
   </data>
+  <data name="Version" xml:space="preserve">
+      <value>Версия: {0}</value>
+  </data>
   <data name="SettingsWelcomeMessagesChannel" xml:space="preserve">
       <value>Канал для приветствий</value>
   </data>

diff --git a/locale/Messages.tt-ru.resx b/locale/Messages.tt-ru.resx
@@ -657,6 +657,9 @@
   <data name="TimeSpanExample" xml:space="preserve">
       <value>правильно пишут так: `1h30m`</value>
   </data>
+  <data name="Version" xml:space="preserve">
+      <value>{0}</value>
+  </data>
   <data name="SettingsWelcomeMessagesChannel" xml:space="preserve">
       <value>канал куда говорить здравствуйте</value>
   </data>

diff --git a/src/BuildInfo.cs b/src/BuildInfo.cs
@@ -0,0 +1,52 @@
+namespace Octobot;
+
+public static class BuildInfo
+{
+    public static string RepositoryUrl
+    {
+        get
+        {
+            return ThisAssembly.Git.RepositoryUrl;
+        }
+    }
+
+    public static string IssuesUrl
+    {
+        get
+        {
+            return $"{RepositoryUrl}/issues";
+        }
+    }
+
+    private static string Commit
+    {
+        get
+        {
+            return ThisAssembly.Git.Commit;
+        }
+    }
+
+    private static string Branch
+    {
+        get
+        {
+            return ThisAssembly.Git.Branch;
+        }
+    }
+
+    private static bool IsDirty
+    {
+        get
+        {
+            return ThisAssembly.Git.IsDirty;
+        }
+    }
+
+    public static string Version
+    {
+        get
+        {
+            return IsDirty ? $"{Branch}-{Commit}-dirty" : $"{Branch}-{Commit}";
+        }
+    }
+}
diff --git a/src/Commands/AboutCommandGroup.cs b/src/Commands/AboutCommandGroup.cs
@@ -101,20 +101,21 @@ private async Task<Result> SendAboutBotAsync(IUser bot, Snowflake guildId, Cance
             .WithDescription(builder.ToString())
             .WithColour(ColorsList.Cyan)
             .WithImageUrl("https://i.ibb.co/fS6wZhh/octobot-banner.png")
+            .WithFooter(string.Format(Messages.Version, BuildInfo.Version))
             .Build();
 
         var repositoryButton = new ButtonComponent(
             ButtonComponentStyle.Link,
             Messages.ButtonOpenRepository,
             new PartialEmoji(Name: "🌐"),
-            URL: Octobot.RepositoryUrl
+            URL: BuildInfo.RepositoryUrl
         );
 
         var issuesButton = new ButtonComponent(
             ButtonComponentStyle.Link,
             Messages.ButtonReportIssue,
             new PartialEmoji(Name: "⚠️"),
-            URL: Octobot.IssuesUrl
+            URL: BuildInfo.IssuesUrl
         );
 
         return await _feedback.SendContextualEmbedResultAsync(embed,

diff --git a/src/Commands/Events/ErrorLoggingPostExecutionEvent.cs b/src/Commands/Events/ErrorLoggingPostExecutionEvent.cs
@@ -72,7 +72,7 @@ public async Task<Result> AfterExecutionAsync(
             ButtonComponentStyle.Link,
             Messages.ButtonReportIssue,
             new PartialEmoji(Name: "⚠️"),
-            URL: Octobot.IssuesUrl
+            URL: BuildInfo.IssuesUrl
         );
 
         return await _feedback.SendContextualEmbedResultAsync(embed,

diff --git a/src/Messages.Designer.cs b/src/Messages.Designer.cs
diff --git a/src/Octobot.cs b/src/Octobot.cs
@@ -22,9 +22,6 @@ namespace Octobot;
 
 public sealed class Octobot
 {
-    public const string RepositoryUrl = "https://github.com/TeamOctolings/Octobot";
-    public const string IssuesUrl = $"{RepositoryUrl}/issues";
-
     public static readonly AllowedMentions NoMentions = new(
         Array.Empty<MentionType>(), Array.Empty<Snowflake>(), Array.Empty<Snowflake>());
 

diff --git a/src/Responders/GuildLoadedResponder.cs b/src/Responders/GuildLoadedResponder.cs
@@ -117,7 +117,7 @@ private async Task<Result> SendDataLoadFailed(IGuild guild, GuildData data, IUse
             ButtonComponentStyle.Link,
             Messages.ButtonReportIssue,
             new PartialEmoji(Name: "⚠️"),
-            URL: Octobot.IssuesUrl
+            URL: BuildInfo.IssuesUrl
         );
 
         return await _channelApi.CreateMessageWithEmbedResultAsync(channel, embedResult: errorEmbed,