-
Notifications
You must be signed in to change notification settings - Fork 659
docs: redesign site with shared versioned guides and API references #5185
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| using Docs.Utilities; | ||
|
|
||
| namespace Docs.Tasks; | ||
|
|
||
| [TaskName(nameof(PrepareDocsInputs))] | ||
| [TaskDescription("Resolve documentation trains and cache their release inputs")] | ||
| public sealed class PrepareDocsInputs : FrostingTask<BuildContext> | ||
| { | ||
| public override void Run(BuildContext context) => context.DocumentationInputs = new DocsInputs( | ||
| context.Environment.WorkingDirectory.FullPath, message => context.Information(message)).Prepare().GetAwaiter().GetResult(); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| using System.Xml.Linq; | ||
| using Microsoft.CodeAnalysis; | ||
| using Microsoft.CodeAnalysis.CSharp; | ||
| using Microsoft.CodeAnalysis.CSharp.Syntax; | ||
| using Path = System.IO.Path; | ||
|
|
||
| namespace Docs.Utilities; | ||
|
|
||
| public static class DocsApi | ||
| { | ||
| // Published binaries define the API. Tagged source supplies comments missing from the packages. | ||
| public static void Prepare(string source, string assemblies) | ||
| { | ||
| var references = Directory.GetFiles(assemblies, "*.dll") | ||
| .Select(p => MetadataReference.CreateFromFile(p)).ToArray(); | ||
| var inventory = new List<string>(); | ||
| var routes = new List<string>(); | ||
| foreach (var assembly in references.Where(r => Path.GetFileName(r.FilePath!).StartsWith("GitVersion", StringComparison.OrdinalIgnoreCase))) | ||
| { | ||
| var name = Path.GetFileNameWithoutExtension(assembly.FilePath!); | ||
| var metadata = CSharpCompilation.Create("Inventory", references: references); | ||
| var symbol = metadata.GetAssemblyOrModuleSymbol(assembly) as IAssemblySymbol | ||
| ?? throw new InvalidOperationException($"Could not inspect {name}."); | ||
| var exported = Types(symbol.GlobalNamespace).Where(Public).ToArray(); | ||
| inventory.AddRange(exported.Select(t => t.GetDocumentationCommentId()!).Where(id => id is not null)); | ||
| routes.AddRange(exported.Select(t => t.ContainingNamespace.ToDisplayString() + "/" + t.MetadataName.Replace('`', '_') + "/index.html")); | ||
| SupplementComments(source, assemblies, references, assembly, name); | ||
| } | ||
| File.WriteAllLines(Path.Combine(assemblies, "public-types.txt"), inventory.Order(StringComparer.Ordinal)); | ||
| File.WriteAllLines(Path.Combine(assemblies, "public-type-routes.txt"), routes.Order(StringComparer.Ordinal)); | ||
| } | ||
|
|
||
| private static void SupplementComments(string source, string assemblies, PortableExecutableReference[] references, PortableExecutableReference assembly, string name) | ||
| { | ||
| var project = Path.Combine(source, "src", name == "gitversion" ? "GitVersion.App" : name); | ||
| if (!Directory.Exists(project)) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| var trees = Directory.GetFiles(project, "*.cs", SearchOption.AllDirectories) | ||
| .Where(p => !Path.GetRelativePath(project, p).Split(Path.DirectorySeparatorChar).Any(s => s is "bin" or "obj" or "Templates")) | ||
| .Select(p => CSharpSyntaxTree.ParseText(File.ReadAllText(p), new CSharpParseOptions(documentationMode: DocumentationMode.Diagnose), p)).ToArray(); | ||
| var compilation = CSharpCompilation.Create(name, trees, references.Where(r => r != assembly), | ||
| new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary)); | ||
| var path = Path.Combine(assemblies, name + ".xml"); | ||
| var document = File.Exists(path) ? XDocument.Load(path) : new XDocument(new XElement("doc", new XElement("assembly", new XElement("name", name)), new XElement("members"))); | ||
| var members = document.Root!.Element("members")!; | ||
| var existing = members.Elements("member").Select(m => (string?)m.Attribute("name")).ToHashSet(); | ||
| foreach (var tree in trees) | ||
| { | ||
| AddTreeComments(compilation.GetSemanticModel(tree), tree, members, existing); | ||
| } | ||
|
|
||
| document.Save(path); | ||
| } | ||
|
|
||
| private static void AddTreeComments(SemanticModel model, SyntaxTree tree, XElement members, HashSet<string?> existing) | ||
| { | ||
| foreach (var node in tree.GetRoot().DescendantNodes().Where(n => n is MemberDeclarationSyntax or VariableDeclaratorSyntax)) | ||
| { | ||
| var declared = model.GetDeclaredSymbol(node); | ||
| var id = declared?.GetDocumentationCommentId(); | ||
| if (id is null || existing.Contains(id)) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| var xml = declared!.GetDocumentationCommentXml(); | ||
| if (string.IsNullOrWhiteSpace(xml)) | ||
| { | ||
| continue; | ||
| } | ||
|
|
||
| try { members.Add(XElement.Parse(xml)); existing.Add(id); } | ||
| catch (System.Xml.XmlException e) { throw new InvalidOperationException($"Invalid API comment for {id} in {tree.FilePath}", e); } | ||
| } | ||
|
|
||
| } | ||
|
|
||
| private static IEnumerable<INamedTypeSymbol> Types(INamespaceOrTypeSymbol parent) | ||
| { | ||
| foreach (var member in parent.GetMembers()) | ||
| { | ||
| if (member is INamedTypeSymbol type) | ||
| { | ||
| yield return type; | ||
| } | ||
|
|
||
| if (member is INamespaceOrTypeSymbol container) | ||
| { | ||
| foreach (var child in Types(container)) | ||
| { | ||
| yield return child; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private static bool Public(INamedTypeSymbol type) => type.DeclaredAccessibility == Accessibility.Public | ||
| && !type.Name.Contains('<') && type.ContainingNamespace.ToDisplayString().StartsWith("GitVersion", StringComparison.Ordinal) | ||
| && (type.ContainingType is null || Public(type.ContainingType)); | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.