Merge pull request #1154 from tspascoal/skip-versioncheck

Add capability to skip version checks

README.md

@@ -87,6 +87,10 @@ Refer to the [official documentation](https://docs.github.com/en/migrations/usin
 
 Refer to the [official documentation](https://docs.github.com/en/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-bitbucket-server-to-github-enterprise-cloud) for more details.
 
+### Skipping version checks
+
+When the CLI is launched, it logs if a newer version of the CLI is available. You can skip this check by setting the `GEI_SKIP_VERSION_CHECK` environment variable to `true`. 
+
 ### Skipping GitHub status checks
 
 When the CLI is launched, it logs a warning if there are any ongoing [GitHub incidents](https://www.githubstatus.com/) that might affect your use of the CLI. You can skip this check by setting the `GEI_SKIP_STATUS_CHECK` environment variable to `true`. 

RELEASENOTES.md

@@ -1 +1,2 @@
 
+- Skip latest version check on startup if environment variable `GEI_SKIP_VERSION_CHECK` is set to `true`

src/Octoshift/Services/EnvironmentVariableProvider.cs

@@ -17,6 +17,7 @@ public class EnvironmentVariableProvider
     private const string BBS_PASSWORD = "BBS_PASSWORD";
     private const string SMB_PASSWORD = "SMB_PASSWORD";
     private const string GEI_SKIP_STATUS_CHECK = "GEI_SKIP_STATUS_CHECK";
+    private const string GEI_SKIP_VERSION_CHECK = "GEI_SKIP_VERSION_CHECK";
 
     private readonly OctoLogger _logger;
 
@@ -61,6 +62,9 @@ public virtual string SmbPassword(bool throwIfNotFound = true) =>
     public virtual string SkipStatusCheck(bool throwIfNotFound = false) =>
         GetValue(GEI_SKIP_STATUS_CHECK, throwIfNotFound);
 
+    public virtual string SkipVersionCheck(bool throwIfNotFound = false) =>
+        GetValue(GEI_SKIP_VERSION_CHECK, throwIfNotFound);
+
     private string GetValue(string name, bool throwIfNotFound)
     {
         var value = Environment.GetEnvironmentVariable(name);

src/OctoshiftCLI.Tests/Octoshift/Services/EnvironmentVariableProviderTests.cs

@@ -18,6 +18,7 @@ public class EnvironmentVariableProviderTests
     private const string BBS_USERNAME = "BBS_USERNAME";
     private const string BBS_PASSWORD = "BBS_PASSWORD";
     private const string GEI_SKIP_STATUS_CHECK = "GEI_SKIP_STATUS_CHECK";
+    private const string GEI_SKIP_VERSION_CHECK = "GEI_SKIP_VERSION_CHECK";
 
     private readonly EnvironmentVariableProvider _environmentVariableProvider;
     private readonly Mock<OctoLogger> _mockLogger = TestHelpers.CreateMock<OctoLogger>();
@@ -154,5 +155,6 @@ private void ResetEnvs()
         Environment.SetEnvironmentVariable(BBS_USERNAME, null);
         Environment.SetEnvironmentVariable(BBS_PASSWORD, null);
         Environment.SetEnvironmentVariable(GEI_SKIP_STATUS_CHECK, null);
+        Environment.SetEnvironmentVariable(GEI_SKIP_VERSION_CHECK, null);
     }
 }

src/ado2gh/Program.cs

@@ -114,6 +114,14 @@ private static async Task GithubStatusCheck(ServiceProvider sp)
 
         private static async Task LatestVersionCheck(ServiceProvider sp)
         {
+            var envProvider = sp.GetRequiredService<EnvironmentVariableProvider>();
+
+            if (envProvider.SkipVersionCheck()?.ToUpperInvariant() is "TRUE" or "1")
+            {
+                Logger.LogInformation("Skipped latest version check due to GEI_VERSION_CHECK environment variable");
+                return;
+            }
+
             var versionChecker = sp.GetRequiredService<VersionChecker>();
 
             if (await versionChecker.IsLatest())

src/bbs2gh/Program.cs

@@ -121,6 +121,14 @@ private static async Task GithubStatusCheck(ServiceProvider sp)
 
         private static async Task LatestVersionCheck(ServiceProvider sp)
         {
+            var envProvider = sp.GetRequiredService<EnvironmentVariableProvider>();
+
+            if (envProvider.SkipVersionCheck()?.ToUpperInvariant() is "TRUE" or "1")
+            {
+                Logger.LogInformation("Skipped latest version check due to GEI_VERSION_CHECK environment variable");
+                return;
+            }
+
             var versionChecker = sp.GetRequiredService<VersionChecker>();
 
             if (await versionChecker.IsLatest())

src/gei/Program.cs

@@ -114,6 +114,14 @@ private static async Task GithubStatusCheck(ServiceProvider sp)
 
         private static async Task LatestVersionCheck(ServiceProvider sp)
         {
+            var envProvider = sp.GetRequiredService<EnvironmentVariableProvider>();
+
+            if (envProvider.SkipVersionCheck()?.ToUpperInvariant() is "TRUE" or "1")
+            {
+                Logger.LogInformation("Skipped latest version check due to GEI_VERSION_CHECK environment variable");
+                return;
+            }
+
             var versionChecker = sp.GetRequiredService<VersionChecker>();
 
             if (await versionChecker.IsLatest())