Add better message for Connecting To GitHub to differentiate GitHub…

… tokens
xoofx · Sep 8, 2023 · ff9ee05 · ff9ee05
1 parent 53e0a01
commit ff9ee05
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 9 deletions.
diff --git a/src/DotNetReleaser.Tests/BasicTests.cs b/src/DotNetReleaser.Tests/BasicTests.cs
@@ -40,7 +40,7 @@ public async Task CheckGitHub()
 
             var logger = new MockSimpleLogger();
 
-            var githubHosting = new GitHubDevHosting(logger, devHosting, "TBD");
+            var githubHosting = new GitHubDevHosting(logger, devHosting, "TBD", "TBD");
             var branches = await githubHosting.GetBranchNamesForCommit("xoofx", "dotnet-releaser", "afe9d28493c05d24f16b5ffdac011b73f66e3c5c");
         }
 

diff --git a/src/DotNetReleaser.Tests/MockDevHosting.cs b/src/DotNetReleaser.Tests/MockDevHosting.cs
@@ -15,12 +15,14 @@ public MockDevHosting(ISimpleLogger logger, DevHostingConfiguration configuratio
         Logger = logger;
         Configuration = configuration;
         ApiToken = string.Empty;
+        ApiTokenUsage = string.Empty;
     }
 
     public ISimpleLogger Logger { get; }
 
     public DevHostingConfiguration Configuration { get; }
     public string ApiToken { get; }
+    public string ApiTokenUsage { get; }
 
     public Task<bool> Connect()
 

diff --git a/src/dotnet-releaser/DevHosting/GitHubDevHosting.cs b/src/dotnet-releaser/DevHosting/GitHubDevHosting.cs
@@ -22,13 +22,14 @@ public class GitHubDevHosting : IDevHosting
     private readonly string _apiToken;
     private readonly GitHubClient _client;
 
-    public GitHubDevHosting(ISimpleLogger log, DevHostingConfiguration hostingConfiguration, string apiToken)
+    public GitHubDevHosting(ISimpleLogger log, DevHostingConfiguration hostingConfiguration, string apiToken, string apiTokenUsage)
     {
         Logger = log;
         Configuration = hostingConfiguration;
         _log = log;
         _url = hostingConfiguration.Base;
         _apiToken = apiToken;
+        ApiTokenUsage = apiTokenUsage;
         _client = new GitHubClient(new ProductHeaderValue(nameof(ReleaserApp)), new Uri(hostingConfiguration.Api));
     }
 
@@ -38,20 +39,21 @@ public GitHubDevHosting(ISimpleLogger log, DevHostingConfiguration hostingConfig
 
     public DevHostingConfiguration Configuration { get; }
     public string ApiToken => _apiToken;
+    public string ApiTokenUsage { get; }
 
     public async Task<bool> Connect()
     {
         var tokenAuth = new Credentials(_apiToken); // NOTE: not real token
         _client.Credentials = tokenAuth;
 
-        _log.Info("Connecting to GitHub");
+        _log.Info($"Connecting to GitHub ({ApiTokenUsage})");
         try
         {
             _ = await _client.Repository.Get(Configuration.User, Configuration.Repo);
         }
         catch (Exception ex)
         {
-            _log.Error($"Unable to connect GitHub. Reason: {ex.Message}");
+            _log.Error($"Unable to connect GitHub ({ApiTokenUsage}). Reason: {ex.Message}");
             return false;
         }
         return true;

diff --git a/src/dotnet-releaser/IDevHosting.cs b/src/dotnet-releaser/IDevHosting.cs
@@ -21,6 +21,8 @@ public interface IDevHosting
     DevHostingConfiguration Configuration { get; }
 
     string ApiToken { get; }
+
+    string ApiTokenUsage { get; }
 
     Task<bool> Connect();
 

diff --git a/src/dotnet-releaser/ReleaserApp.Changelog.cs b/src/dotnet-releaser/ReleaserApp.Changelog.cs
@@ -26,7 +26,7 @@ private async Task<bool> ListOrUpdateChangelog(string configurationFilePath, str
             return false;
         }
 
-        var devHosting = await ConnectToDevHosting(_config.GitHub, githubApiToken);
+        var devHosting = await ConnectToDevHosting(_config.GitHub, githubApiToken, "For Fetching Changelog");
         if (devHosting is null) return false;
 
         return await ListOrUpdateChangelog(devHosting, version, update);

diff --git a/src/dotnet-releaser/ReleaserApp.Configuring.cs b/src/dotnet-releaser/ReleaserApp.Configuring.cs
@@ -53,7 +53,7 @@ public partial class ReleaserApp
         // Connect to GitHub if we have a token
         if (!string.IsNullOrEmpty(githubApiToken))
         {
-            devHosting = await ConnectToDevHosting(hostingConfiguration, githubApiToken);
+            devHosting = await ConnectToDevHosting(hostingConfiguration, githubApiToken, "For this CI");
             if (devHosting is null)
             {
                 return null; // return false;
@@ -63,7 +63,7 @@ public partial class ReleaserApp
         // Connet to GitHub for extra access
         if (!string.IsNullOrEmpty(githubApiTokenExtra))
         {
-            devHostingExtra = await ConnectToDevHosting(hostingConfiguration, githubApiTokenExtra);
+            devHostingExtra = await ConnectToDevHosting(hostingConfiguration, githubApiTokenExtra, "For External Repositories");
             if (devHostingExtra is null)
             {
                 return null; // return false;

diff --git a/src/dotnet-releaser/ReleaserApp.DevHosting.cs b/src/dotnet-releaser/ReleaserApp.DevHosting.cs
@@ -6,9 +6,9 @@ namespace DotNetReleaser;
 
 public partial class ReleaserApp 
 {
-    private async Task<IDevHosting?> ConnectToDevHosting(DevHostingConfiguration hostingConfiguration, string githubApiToken)
+    private async Task<IDevHosting?> ConnectToDevHosting(DevHostingConfiguration hostingConfiguration, string githubApiToken, string apiTokenUsage)
     {
-        var hosting = new GitHubDevHosting(_logger, hostingConfiguration, githubApiToken);
+        var hosting = new GitHubDevHosting(_logger, hostingConfiguration, githubApiToken, apiTokenUsage);
 
         if (await hosting.Connect())
         {