chore: Add logics to avoid generating invalid link (#10854)

* chore: add logics to avoid generating invalid link

* test(snapshot): update snapshots 4735c28

---------

Co-authored-by: Yufei Huang <[email protected]>

Author: filzrev

src/Docfx.Common/Git/GitUtility.cs

@@ -34,6 +34,10 @@ record Repo(string path, string url, string branch);
         if (EnvironmentContext.GitFeaturesDisabled)
             return null;
 
+        // Return null when file path `/obj/` to avoid generating invalid link.
+        if (filePath.Contains("/obj/") || filePath.Contains("\\obj\\"))
+            return null;
+
         var repo = GetRepoInfo(Path.GetDirectoryName(filePath));
         if (repo is null)
             return null;

test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.Class1.html.view.verified.json

@@ -2,21 +2,11 @@
   "conceptual": "\n<p sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"3\">Namespace: <a href=\"~/obj/md/BuildFromAssembly.md\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"3\">BuildFromAssembly</a><br>\nAssembly: BuildFromAssembly.dll</p>\n<p sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"6\">This is a test class.</p>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"8\">public class Class1\n</code></pre>\n<h4 id=\"inheritance\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"12\">Inheritance</h4>\n<p sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"14\"><a href=\"https://learn.microsoft.com/dotnet/api/system.object\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"14\">object</a> ←\n<a href=\"~/obj/md/BuildFromAssembly.Class1.md\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"15\">Class1</a></p>\n<h4 id=\"inherited-members\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"17\">Inherited Members</h4>\n<p sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"19\"><a href=\"https://learn.microsoft.com/dotnet/api/system.object.gettype\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"19\">object.GetType()</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"20\">object.MemberwiseClone()</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.tostring\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"21\">object.ToString()</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"22\">object.Equals(object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"23\">object.Equals(object?, object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.referenceequals\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"24\">object.ReferenceEquals(object?, object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.gethashcode\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"25\">object.GetHashCode()</a></p>\n<h2 id=\"constructors\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"27\">Constructors</h2>\n<h3 id=\"BuildFromAssembly_Class1__ctor\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"29\"> Class1()</h3>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"31\">public Class1()\n</code></pre>\n<h2 id=\"methods\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"35\">Methods</h2>\n<h3 id=\"BuildFromAssembly_Class1_HelloWorld\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"37\"> HelloWorld()</h3>\n<p sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"39\">Hello World.</p>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromAssembly.Class1.md\" sourcestartlinenumber=\"41\">public static void HelloWorld()\n</code></pre>\n",
   "type": "Conceptual",
   "source": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromAssembly.Class1.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
   "path": "obj/md/BuildFromAssembly.Class1.md",
   "documentation": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromAssembly.Class1.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
@@ -38,5 +28,5 @@
   "_tocPath": "md/toc.html",
   "_tocRel": "toc.html",
   "_disableToc": false,
-  "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromAssembly.Class1.md/#L1"
+  "docurl": ""
 }

test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.Issue5432.html.view.verified.json

@@ -2,21 +2,11 @@
   "conceptual": "\n<p sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"3\">Namespace: <a href=\"~/obj/md/BuildFromAssembly.md\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"3\">BuildFromAssembly</a><br>\nAssembly: BuildFromAssembly.dll</p>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"6\">public struct Issue5432\n</code></pre>\n<h4 id=\"inherited-members\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"10\">Inherited Members</h4>\n<p sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"12\"><a href=\"https://learn.microsoft.com/dotnet/api/system.object.gettype\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"12\">object.GetType()</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.tostring\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"13\">object.ToString()</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"14\">object.Equals(object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"15\">object.Equals(object?, object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.referenceequals\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"16\">object.ReferenceEquals(object?, object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.gethashcode\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"17\">object.GetHashCode()</a></p>\n<h2 id=\"properties\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"19\">Properties</h2>\n<h3 id=\"BuildFromAssembly_Issue5432_Name\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"21\"> Name</h3>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"23\">public string Name { get; }\n</code></pre>\n<h4 id=\"property-value\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"27\">Property Value</h4>\n<p sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"29\"><a href=\"https://learn.microsoft.com/dotnet/api/system.string\" sourcefile=\"obj/md/BuildFromAssembly.Issue5432.md\" sourcestartlinenumber=\"29\">string</a></p>\n",
   "type": "Conceptual",
   "source": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromAssembly.Issue5432.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
   "path": "obj/md/BuildFromAssembly.Issue5432.md",
   "documentation": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromAssembly.Issue5432.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
@@ -38,5 +28,5 @@
   "_tocPath": "md/toc.html",
   "_tocRel": "toc.html",
   "_disableToc": false,
-  "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromAssembly.Issue5432.md/#L1"
+  "docurl": ""
 }

test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromAssembly.html.view.verified.json

@@ -2,21 +2,11 @@
   "conceptual": "\n<h3 id=\"classes\" sourcefile=\"obj/md/BuildFromAssembly.md\" sourcestartlinenumber=\"3\">Classes</h3>\n<p sourcefile=\"obj/md/BuildFromAssembly.md\" sourcestartlinenumber=\"5\"><a href=\"~/obj/md/BuildFromAssembly.Class1.md\" sourcefile=\"obj/md/BuildFromAssembly.md\" sourcestartlinenumber=\"5\">Class1</a></p>\n<p sourcefile=\"obj/md/BuildFromAssembly.md\" sourcestartlinenumber=\"7\">This is a test class.</p>\n<h3 id=\"structs\" sourcefile=\"obj/md/BuildFromAssembly.md\" sourcestartlinenumber=\"9\">Structs</h3>\n<p sourcefile=\"obj/md/BuildFromAssembly.md\" sourcestartlinenumber=\"11\"><a href=\"~/obj/md/BuildFromAssembly.Issue5432.md\" sourcefile=\"obj/md/BuildFromAssembly.md\" sourcestartlinenumber=\"11\">Issue5432</a></p>\n",
   "type": "Conceptual",
   "source": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromAssembly.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
   "path": "obj/md/BuildFromAssembly.md",
   "documentation": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromAssembly.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
@@ -38,5 +28,5 @@
   "_tocPath": "md/toc.html",
   "_tocRel": "toc.html",
   "_disableToc": false,
-  "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromAssembly.md/#L1"
+  "docurl": ""
 }

test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.CSharp.html.view.verified.json

@@ -2,21 +2,11 @@
   "conceptual": "\n<p sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"3\">Namespace: <a href=\"~/obj/md/BuildFromCSharpSourceCode.md\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"3\">BuildFromCSharpSourceCode</a></p>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"5\">public class CSharp\n</code></pre>\n<h4 id=\"inheritance\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"9\">Inheritance</h4>\n<p sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"11\"><a href=\"https://learn.microsoft.com/dotnet/api/system.object\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"11\">object</a> ←\n<a href=\"~/obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"12\">CSharp</a></p>\n<h4 id=\"inherited-members\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"14\">Inherited Members</h4>\n<p sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"16\"><a href=\"https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"16\">object.Equals(object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"17\">object.Equals(object?, object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.gethashcode\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"18\">object.GetHashCode()</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.gettype\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"19\">object.GetType()</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"20\">object.MemberwiseClone()</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.referenceequals\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"21\">object.ReferenceEquals(object?, object?)</a>,\n<a href=\"https://learn.microsoft.com/dotnet/api/system.object.tostring\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"22\">object.ToString()</a></p>\n<h2 id=\"methods\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"24\">Methods</h2>\n<h3 id=\"BuildFromCSharpSourceCode_CSharp_Main_System_String___\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"26\"> Main(string[])</h3>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"28\">public static void Main(string[] args)\n</code></pre>\n<h4 id=\"parameters\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"32\">Parameters</h4>\n<p sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"34\"><code sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"34\">args</code> <a href=\"https://learn.microsoft.com/dotnet/api/system.string\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcestartlinenumber=\"34\">string</a>[]</p>\n",
   "type": "Conceptual",
   "source": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromCSharpSourceCode.CSharp.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
   "path": "obj/md/BuildFromCSharpSourceCode.CSharp.md",
   "documentation": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromCSharpSourceCode.CSharp.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
@@ -38,5 +28,5 @@
   "_tocPath": "md/toc.html",
   "_tocRel": "toc.html",
   "_disableToc": false,
-  "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromCSharpSourceCode.CSharp.md/#L1"
+  "docurl": ""
 }

test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromCSharpSourceCode.html.view.verified.json

@@ -2,21 +2,11 @@
   "conceptual": "\n<h3 id=\"classes\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.md\" sourcestartlinenumber=\"3\">Classes</h3>\n<p sourcefile=\"obj/md/BuildFromCSharpSourceCode.md\" sourcestartlinenumber=\"5\"><a href=\"~/obj/md/BuildFromCSharpSourceCode.CSharp.md\" sourcefile=\"obj/md/BuildFromCSharpSourceCode.md\" sourcestartlinenumber=\"5\">CSharp</a></p>\n",
   "type": "Conceptual",
   "source": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromCSharpSourceCode.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
   "path": "obj/md/BuildFromCSharpSourceCode.md",
   "documentation": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromCSharpSourceCode.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
@@ -38,5 +28,5 @@
   "_tocPath": "md/toc.html",
   "_tocRel": "toc.html",
   "_disableToc": false,
-  "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromCSharpSourceCode.md/#L1"
+  "docurl": ""
 }

test/docfx.Snapshot.Tests/SamplesTest.Seed/md/BuildFromProject.Class1.IIssue8948.html.view.verified.json

@@ -2,21 +2,11 @@
   "conceptual": "\n<p sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"3\">Namespace: <a href=\"~/obj/md/BuildFromProject.md\" sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"3\">BuildFromProject</a><br>\nAssembly: BuildFromProject.dll</p>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"6\">public interface Class1.IIssue8948\n</code></pre>\n<h2 id=\"methods\" sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"10\">Methods</h2>\n<h3 id=\"BuildFromProject_Class1_IIssue8948_DoNothing__1\" sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"12\"> DoNothing&lt;T&gt;()</h3>\n<p sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"14\">Does nothing with generic type <code class=\"typeparamref\">T</code>.</p>\n<pre><code class=\"lang-csharp\" sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"16\">void DoNothing&lt;T&gt;()\n</code></pre>\n<h4 id=\"type-parameters\" sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"20\">Type Parameters</h4>\n<p sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"22\"><code sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"22\">T</code></p>\n<p sourcefile=\"obj/md/BuildFromProject.Class1.IIssue8948.md\" sourcestartlinenumber=\"24\">A generic type.</p>\n",
   "type": "Conceptual",
   "source": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromProject.Class1.IIssue8948.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
   "path": "obj/md/BuildFromProject.Class1.IIssue8948.md",
   "documentation": {
-    "remote": {
-      "path": "samples/seed/obj/md/BuildFromProject.Class1.IIssue8948.md",
-      "branch": "main",
-      "repo": "https://github.com/dotnet/docfx"
-    },
     "startLine": 0,
     "endLine": 0
   },
@@ -38,5 +28,5 @@
   "_tocPath": "md/toc.html",
   "_tocRel": "toc.html",
   "_disableToc": false,
-  "docurl": "https://github.com/dotnet/docfx/blob/main/samples/seed/obj/md/BuildFromProject.Class1.IIssue8948.md/#L1"
+  "docurl": ""
 }