Merge branch 'master' into feature/show-current-pr

Author: jcansdale

CONTRIBUTING.md

@@ -7,6 +7,8 @@
 
 Hi there! We're thrilled that you'd like to contribute to the __GitHub Extension for Visual Studio__. Your help is essential for keeping it great.
 
+Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.md).
+
 This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to uphold this code.
 
 ## Submitting a pull request

ISSUE_TEMPLATE.md

@@ -1,6 +1,6 @@
 Hello! Please read the contributing guidelines before submitting an issue regarding the GitHub Extension for Visual Studio.
 
-- GitHub Extension for Visual Studio  version:
+- GitHub Extension for Visual Studio version:
 - Visual Studio version:
 
 __What happened__ (with steps, logs and screenshots, if possible)

docs/getting-started/authenticating-to-github.md

@@ -7,7 +7,12 @@ Before you authenticate, you must already have a GitHub or GitHub Enterprise acc
 - For more information on creating a GitHub account, see "[Signing up for a new GitHub account](https://help.github.com/articles/signing-up-for-a-new-github-account/)".
 - For a GitHub Enterprise account, contact your GitHub Enterprise site administrator.
 
-> **Note:** If your organization is on the [Business plan](https://help.github.com/articles/organization-billing-plans) and has enabled SAML single sign-on, you must create and authorize a personal access token to access protected content. For more information on creating personal access tokens, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). For more information on authenticating with SAML single sign-on, see "[About authentication with SAML single sign-on](https://help.github.com/articles/about-authentication-with-saml-single-sign-on)."
+> **Note:** If your organization is on the [Business plan](https://help.github.com/articles/organization-billing-plans) and has not enabled SAML single sign-on or login with username and passowrd, you must create and authorize a personal access token to access protected content. In addition, SAML single sign-on is not available for GitHub enterprise versions less than 2.12.2.
+
+> For more information on authenticating with SAML single sign-on, see "[About authentication with SAML single sign-on](https://help.github.com/articles/about-authentication-with-saml-single-sign-on)."
+
+> For more information on creating personal access tokens, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line). The required scopes for the personal access token are: `user`, `repo`, `gist`, and `write:public_key`. 
+
 
 1. In Visual Studio, select **Team Explorer** from the **View** menu.
 ![Team Explorer in the view menu](images/view_team_explorer.png)
@@ -16,4 +21,13 @@ Before you authenticate, you must already have a GitHub or GitHub Enterprise acc
 3. Click the **Connect** link in the GitHub section. If you are already connected to a GitHub instance and want to connect to another, this link will not be visible; instead click **Manage Connections** and then **Connect to GitHub**.
 ![Connect to GitHub in the manage connections dropdown in the Team Explorer pane](images/connect_to_github.png)
 4. In the **Connect to GitHub dialog** choose **GitHub** or **GitHub Enterprise**, depending on which product you're using.
-5. Type your credentials, then click **Sign In**.
+
+**GitHub option**:  
+![Connect to GitHub dialog view](images/connect-to-github-dialog.png)
+- To sign in with credentials, enter either username or email and password.
+- To sign in with SSO, select `Sign in with your browser`.
+
+**GitHub Enterprise option**:  
+![Connect to GitHub Enterprise dialog view](images/connect-to-github-enterprise-dialog.png)
+- To sign in with credentials, first enter GitHub Enterprise server address. Once a valid server address is entered, a `Token` field appears and a valid token can be entered to sign in.
+  - To sign in with SSO, first enter the GitHub Enterprise server address. Once a valid server address is entered, select `Sign in with your browser`. Follow the steps to authenticate with your SSO provider.

docs/getting-started/images/connect-to-github-dialog.png

@@ -242,7 +242,8 @@ public IObservable<PullRequest> GetPullRequestsForRepository(string owner, strin
             Guard.ArgumentNotEmptyString(name, nameof(name));
 
             return gitHubClient.PullRequest.GetAllForRepository(owner, name,
-                new PullRequestRequest {
+                new PullRequestRequest
+                {
                     State = ItemStateFilter.All,
                     SortProperty = PullRequestSort.Updated,
                     SortDirection = SortDirection.Descending
@@ -268,7 +269,7 @@ public IObservable<Branch> GetBranches(string owner, string repo)
             Guard.ArgumentNotEmptyString(owner, nameof(owner));
             Guard.ArgumentNotEmptyString(repo, nameof(repo));
 
-#pragma warning disable CS0618
+#pragma warning disable 618
             // GetAllBranches is obsolete, but don't want to introduce the change to fix the
             // warning in the PR, so disabling for now.
             return gitHubClient.Repository.GetAllBranches(owner, repo);

docs/getting-started/images/connect-to-github-enterprise-dialog.png

@@ -30,22 +30,29 @@ public EnterpriseCapabilitiesService(
 
         public async Task<EnterpriseLoginMethods> ProbeLoginMethods(Uri enterpriseBaseUrl)
         {
-            // It's important that we don't use our cached credentials on this connection, as they
-            // may be wrong - we're trying to log in after all.
-            var hostAddress = HostAddress.Create(enterpriseBaseUrl);
-            var connection = new Octokit.Connection(program.ProductHeader, hostAddress.ApiUri);
-            var meta = await GetMetadata(connection).ConfigureAwait(false);
-            var result = EnterpriseLoginMethods.Token;
+            try
+            {
+                // It's important that we don't use our cached credentials on this connection, as they
+                // may be wrong - we're trying to log in after all.
+                var hostAddress = HostAddress.Create(enterpriseBaseUrl);
+                var connection = new Octokit.Connection(program.ProductHeader, hostAddress.ApiUri);
+                var meta = await GetMetadata(connection).ConfigureAwait(false);
+                var result = EnterpriseLoginMethods.Token;
+
+                if (meta.VerifiablePasswordAuthentication != false) result |= EnterpriseLoginMethods.UsernameAndPassword;
 
-            if (meta.VerifiablePasswordAuthentication) result |= EnterpriseLoginMethods.UsernameAndPassword;
+                if (meta.InstalledVersion != null)
+                {
+                    var version = new Version(meta.InstalledVersion);
+                    if (version >= MinimumOAuthVersion) result |= EnterpriseLoginMethods.OAuth;
+                }
 
-            if (meta.InstalledVersion != null)
+                return result;
+            }
+            catch
             {
-                var version = new Version(meta.InstalledVersion);
-                if (version >= MinimumOAuthVersion) result |= EnterpriseLoginMethods.OAuth;
+                return EnterpriseLoginMethods.Token | EnterpriseLoginMethods.UsernameAndPassword;
             }
-
-            return result;
         }
 
         private async Task<EnterpriseMeta> GetMetadata(IConnection connection)
@@ -56,9 +63,10 @@ private async Task<EnterpriseMeta> GetMetadata(IConnection connection)
         }
 
         [SuppressMessage("Microsoft.Performance", "CA1812:AvoidUninstantiatedInternalClasses", Justification = "Created via Octokit reflection")]
-        class EnterpriseMeta : Meta
+        class EnterpriseMeta
         {
             public string InstalledVersion { get; private set; }
+            public bool? VerifiablePasswordAuthentication { get; private set; }
         }
     }
 }

src/GitHub.App/Api/ApiClient.cs

@@ -76,7 +76,7 @@ void Refresh()
 
                     if (newRepositoryPath != repositoryPath)
                     {
-                        log.Debug("Fire PropertyChanged event for ActiveRepository");
+                        log.Debug("ActiveRepository changed to {CloneUrl} @ {Path}", repo?.CloneUrl, newRepositoryPath);
                         ActiveRepository = repo;
                     }
                     else if (newBranchName != branchName)

src/GitHub.App/Services/EnterpriseCapabilitiesService.cs

@@ -140,22 +140,14 @@ async void EnterpriseUrlChanged(string url, bool valid)
 
             var enterpriseInstance = false;
             var loginMethods = (EnterpriseLoginMethods?)null;
+            var uri = new UriBuilder(url).Uri;
 
-            try
-            {
-                var uri = new UriBuilder(url).Uri;
-                ProbeStatus = EnterpriseProbeStatus.Checking;
+            ProbeStatus = EnterpriseProbeStatus.Checking;
 
-                if (await enterpriseCapabilities.Probe(uri) == EnterpriseProbeResult.Ok)
-                {
-                    loginMethods = await enterpriseCapabilities.ProbeLoginMethods(uri);
-                    enterpriseInstance = true;
-                }
-            }
-            catch
+            if (await enterpriseCapabilities.Probe(uri) == EnterpriseProbeResult.Ok)
             {
-                ProbeStatus = EnterpriseProbeStatus.Invalid;
-                loginMethods = null;
+                loginMethods = await enterpriseCapabilities.ProbeLoginMethods(uri);
+                enterpriseInstance = true;
             }
 
             if (url == EnterpriseUrl)

src/GitHub.App/Services/TeamExplorerContext.cs

@@ -11,11 +11,13 @@
 using GitHub.Extensions;
 using GitHub.Factories;
 using GitHub.Info;
+using GitHub.Logging;
 using GitHub.Models;
 using GitHub.Primitives;
 using GitHub.Services;
 using GitHub.VisualStudio;
 using ReactiveUI;
+using Serilog;
 using OleMenuCommand = Microsoft.VisualStudio.Shell.OleMenuCommand;
 
 namespace GitHub.ViewModels.GitHubPane
@@ -27,6 +29,7 @@ namespace GitHub.ViewModels.GitHubPane
     [PartCreationPolicy(CreationPolicy.NonShared)]
     public sealed class GitHubPaneViewModel : ViewModelBase, IGitHubPaneViewModel, IDisposable
     {
+        static readonly ILogger log = LogManager.ForContext<GitHubPaneViewModel>();
         static readonly Regex pullUri = CreateRoute("/:owner/:repo/pull/:number");
 
         readonly IViewViewModelFactory viewModelFactory;
@@ -353,18 +356,22 @@ async Task NavigateTo<TViewModel>(Func<TViewModel, Task> initialize, Func<TViewM
 
         async Task UpdateContent(ILocalRepositoryModel repository)
         {
+            log.Debug("UpdateContent called with {CloneUrl}", repository?.CloneUrl);
+
             LocalRepository = repository;
             Connection = null;
             Content = null;
             navigator.Clear();
 
             if (repository == null)
             {
+                log.Debug("Not a git repository: {CloneUrl}", repository?.CloneUrl);
                 Content = notAGitRepository;
                 return;
             }
             else if (string.IsNullOrWhiteSpace(repository.CloneUrl))
             {
+                log.Debug("Not a GitHub repository: {CloneUrl}", repository?.CloneUrl);
                 Content = notAGitHubRepository;
                 return;
             }
@@ -382,16 +389,19 @@ async Task UpdateContent(ILocalRepositoryModel repository)
 
                 if (Connection?.IsLoggedIn == true)
                 {
+                    log.Debug("Found a GitHub repository: {CloneUrl}", repository?.CloneUrl);
                     Content = navigator;
                     await ShowDefaultPage();
                 }
                 else
                 {
+                    log.Debug("Found a a GitHub repository but not logged in: {CloneUrl}", repository?.CloneUrl);
                     Content = loggedOut;
                 }
             }
             else
             {
+                log.Debug("Not a GitHub repository: {CloneUrl}", repository?.CloneUrl);
                 Content = notAGitHubRepository;
             }
         }