Move towards a nuget fetcher way to generate api docs

Author: glennawatson

.github/workflows/main.yml

@@ -8,51 +8,30 @@ on:
 
 jobs:
   build:
-    runs-on: windows-latest
+    runs-on: ubuntu-latest
     steps:
       - name: Setup .NET (With cache)
         uses: actions/setup-dotnet@v5.2.0
         with:
-         dotnet-version: |
-            8.0.x
-            9.0.x
-            10.0.x
-         dotnet-quality: 'preview'
+          dotnet-version: 10.0.x
+          dotnet-quality: 'preview'
 
-      - name: 'Setup Java JDK 11'
-        uses: actions/setup-java@v5.2.0
-        with:
-          distribution: 'microsoft'
-          java-version: '11'
-        
-      - name: 'Add MSBuild to PATH'
-        uses: microsoft/setup-msbuild@v2.0.0
-        with:
-          vs-prerelease: true
-
-      - name: 'Install DotNet workloads'
-        shell: bash
-        run: |
-          dotnet workload install android ios tvos macos maui maccatalyst
-
-      - name: Checkout 
+      - name: Checkout
         uses: actions/checkout@v6
         with:
           fetch-depth: 0
 
-      - name: 'Cache: .nuke/temp, ~/.nuget/packages'
+      - name: 'Cache: .nuke/temp, NuGet packages'
         uses: actions/cache@v5
         with:
           path: |
             .nuke/temp
             ~/.nuget/packages
-          key: ${{ runner.os }}-${{ hashFiles('**/global.json', '**/*.csproj', '**/Directory.Packages.props') }}
+            reactiveui/api/cache
+          key: ${{ runner.os }}-${{ hashFiles('**/global.json', 'nuget-packages.json') }}
 
-      - name: 'Restore and Compile ReactiveUI Projects'
-        run: ./build.cmd Compile
-        
       - name: 'Build Website'
-        run: ./build.cmd BuildWebsite
+        run: ./build.sh BuildWebsite
 
       - name: 'Deploy netlify'
         if: ${{ github.event_name != 'pull_request' }}

.gitignore

@@ -349,5 +349,12 @@ MigrationBackup/
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
 
+reactiveui/api/lib/
+reactiveui/api/cache/
+reactiveui/api/refs/
 reactiveui/api/reactiveui/
 reactiveui/api/reactivemarbles/
+reactiveui/api-android/
+reactiveui/api-test/
+reactiveui/api-windows/
+reactiveui/_site/

.nuke/build.schema.json

@@ -26,8 +26,8 @@
       "enum": [
         "BuildWebsite",
         "Clean",
-        "Compile",
-        "Restore"
+        "FetchPackages",
+        "Serve"
       ]
     },
     "Verbosity": {
@@ -101,13 +101,10 @@
   "allOf": [
     {
       "properties": {
-        "Configuration": {
-          "type": "string",
-          "description": "Configuration to build - Default is 'Debug' (local) or 'Release' (server)",
-          "enum": [
-            "Debug",
-            "Release"
-          ]
+        "Port": {
+          "type": "integer",
+          "description": "Port for the preview server (default: 8080)",
+          "format": "int32"
         }
       }
     },

build.sh

@@ -1,149 +1,59 @@
 using Nuke.Common;
 using Nuke.Common.IO;
-using Nuke.Common.ProjectModel;
 using Nuke.Common.Tooling;
-using Nuke.Common.Tools.DotNet;
-using Nuke.Common.Tools.MSBuild;
 using ReactiveUI.Web;
 using System;
-using System.IO;
-using System.Linq;
-using static Nuke.Common.Tools.DotNet.DotNetTasks;
 
 class Build : NukeBuild
 {
-    /// Support plugins are available for:
-    ///   - JetBrains ReSharper        https://nuke.build/resharper
-    ///   - JetBrains Rider            https://nuke.build/rider
-    ///   - Microsoft VisualStudio     https://nuke.build/visualstudio
-    ///   - Microsoft VSCode           https://nuke.build/vscode
-
-    public static int Main() => Execute<Build>(x => x.Compile);
-
-    [Parameter("Configuration to build - Default is 'Debug' (local) or 'Release' (server)")]
-    readonly Configuration Configuration = IsLocalBuild ? Configuration.Debug : Configuration.Release;
-
-    private static readonly string reactiveui = nameof(reactiveui);
-    private static readonly string akavache = nameof(akavache);
-    private static readonly string fusillade = nameof(fusillade);
-    private static readonly string punchclock = nameof(punchclock);
-    private static readonly string splat = nameof(splat);
-    private static readonly string DynamicData = nameof(DynamicData);
-    private static readonly string reactivemarbles = nameof(reactivemarbles);
-    private static readonly string extensions = nameof(extensions);
-    private static readonly string[] RxUIProjects = [reactiveui, akavache, fusillade, punchclock, splat, "ReactiveUI.Validation", "ReactiveUI.Avalonia", extensions, "Maui.Plugins.Popup"];
-
-    private AbsolutePath RxUIAPIDirectory => RootDirectory / reactiveui / "api" / reactiveui;
-    private AbsolutePath RxMAPIDirectory => RootDirectory / reactiveui / "api" / reactivemarbles;
+    public static int Main() => Execute<Build>(x => x.BuildWebsite);
 
+    private AbsolutePath ApiLibDirectory => RootDirectory / "reactiveui" / "api" / "lib";
+    private AbsolutePath ApiRefsDirectory => RootDirectory / "reactiveui" / "api" / "refs";
+    private AbsolutePath ApiCacheDirectory => RootDirectory / "reactiveui" / "api" / "cache";
 
     Target Clean => _ => _
-        .Before(Restore)
+        .Before(FetchPackages)
         .Executes(() =>
         {
-            RxUIAPIDirectory.DeleteDirectory();
-            RxMAPIDirectory.DeleteDirectory();
+            ApiLibDirectory.DeleteDirectory();
+            ApiRefsDirectory.DeleteDirectory();
             // Install docfx
             ProcessTasks.StartShell("dotnet tool update -g docfx").AssertZeroExitCode();
         });
 
-    Target Restore => _ => _
+    Target FetchPackages => _ => _
         .DependsOn(Clean)
         .Executes(() =>
         {
-            // Restore ReactiveUI Projects
-            RxUIAPIDirectory.GetSources(RootDirectory, reactiveui, RxUIProjects);
-
-            // Restore Reactive Marbles Projects
-            RxMAPIDirectory.GetSources(RootDirectory, reactivemarbles, DynamicData);
+            NuGetFetcher.FetchPackages(RootDirectory);
         });
 
-    Target Compile => _ => _
-        .DependsOn(Restore)
+    Target BuildWebsite => _ => _
+        .DependsOn(FetchPackages)
+        .Produces(RootDirectory / "reactiveui" / "_site")
         .Executes(() =>
         {
-            foreach (var project in RxUIProjects)
-            {
-                try
-                {
-                    var dirRx = RxUIAPIDirectory / "external" / project / $"{project}-main" / "src";
-                    File.Copy(RootDirectory / "global.json", dirRx / "global.json", true);
-                    var solutionFile = dirRx / $"{project}.sln";
-
-                    // Find any .sln or .slnx file as a fallback
-                    var solutionFileSearch = Directory.EnumerateFiles(dirRx, "*.sln*").FirstOrDefault();
-                    if (File.Exists(solutionFile) == false)
-                    {
-                        solutionFile += "x";
-                        if (File.Exists(solutionFile) == false)
-                        {
-                            if (File.Exists(solutionFileSearch))
-                            {
-                                solutionFile = solutionFileSearch;
-                            }
-                            else
-                            {
-                                SourceFetcher.LogRepositoryError(reactiveui, project, $"Solution file not found: {dirRx / $"{project}.sln(x)"}");
-                                continue;
-                            }
-                        }
-                    }
-
-                    SourceFetcher.LogInfo($"Restoring {solutionFile}...");
-                    DotNetRestore(s => s.SetProjectFile(solutionFile));
-                    SourceFetcher.LogInfo($"Building {solutionFile}...");
-                    DotNetBuild(s => s
-                        .SetProjectFile(solutionFile)
-                        .SetConfiguration(Configuration)
-                        .EnableNoRestore());
-                    SourceFetcher.LogInfo($"{project} build complete");
-                }
-                catch (Exception ex)
-                {
-                    SourceFetcher.LogRepositoryError(reactiveui, project, ex.ToString());
-                }
-            }
-
             try
             {
-                var dirDd = RxMAPIDirectory / "external" / DynamicData / $"{DynamicData}-main" / "src";
-                File.Copy(RootDirectory / "global.json", dirDd / "global.json", true);
-                var solutionFile = dirDd / $"{DynamicData}.sln";
-                if (File.Exists(solutionFile) == false)
-                {
-                    solutionFile += "x";
-                    if (File.Exists(solutionFile) == false)
-                    {
-                        SourceFetcher.LogRepositoryError(reactivemarbles, DynamicData, $"Solution file not found: {dirDd / $"{DynamicData}.sln(x)"}");
-                        return;
-                    }
-                }
-
-                SourceFetcher.LogInfo($"Building {solutionFile}...");
-                MSBuildTasks.MSBuild(s => s
-                    .SetProjectFile(solutionFile)
-                    .SetConfiguration(Configuration)
-                    .SetRestore(true));
-                SourceFetcher.LogInfo($"{DynamicData} build complete");
+                NuGetFetcher.PatchDocfxJson(RootDirectory);
+                ProcessTasks.StartShell("docfx reactiveui/docfx.json").AssertZeroExitCode();
+                NuGetFetcher.LogInfo("Web Site build complete");
             }
             catch (Exception ex)
             {
-                SourceFetcher.LogRepositoryError(reactivemarbles, DynamicData, ex.ToString());
+                NuGetFetcher.LogError(ex.ToString());
             }
         });
 
-    Target BuildWebsite => _ => _
-    .Produces(RootDirectory / reactiveui / "_site")
-    .Executes(() =>
-    {
-        try
-        {
-            ProcessTasks.StartShell("docfx reactiveui/docfx.json").AssertZeroExitCode();
-            SourceFetcher.LogInfo("Web Site build complete");
-        }
-        catch (Exception ex)
+    [Parameter("Port for the preview server (default: 8080)")]
+    readonly int Port = 8080;
+
+    Target Serve => _ => _
+        .DependsOn(BuildWebsite)
+        .Executes(() =>
         {
-            SourceFetcher.LogError(ex.ToString());
-        }
-    });
+            NuGetFetcher.LogInfo($"Serving website at http://localhost:{Port}");
+            ProcessTasks.StartShell($"docfx serve reactiveui/_site -p {Port}").AssertZeroExitCode();
+        });
 }