Migrated `Fornax` to `0.16.0-beta002` #736

xperiandri · 2025-07-07T04:47:48Z

No description provided.

Copilot

Pull Request Overview

This PR updates the documentation build to use Fornax.Core v0.15.1 and the new FSharp.Formatting ApiDocs API, replacing local DLL references with NuGet packages and adjusting loader/generator scripts accordingly.

Switch all #r references to nuget: Fornax.Core, 0.15.1 (and related packages)
Update the API reference loader to use FSharp.Formatting.ApiDocs and adjust types/fields
Replace Custom(...) with HtmlProperties.Custom(...) in HTML generators

Reviewed Changes

Copilot reviewed 14 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
docs/loaders/pageloader.fsx	Bump Fornax.Core reference to NuGet
docs/loaders/globalloader.fsx	Bump Fornax.Core reference to NuGet
docs/loaders/copyloader.fsx	Bump Fornax.Core reference to NuGet
docs/loaders/contentloader.fsx	Bump references to NuGet for Fornax.Core and Markdig
docs/loaders/apirefloader.fsx	Migrate from `MetadataFormat` to `ApiDocs.GenerateModel`
docs/generators/partials/menu.fsx	Bump Fornax.Core reference; use `HtmlProperties.Custom`
docs/generators/partials/layout.fsx	Bump Fornax.Core reference; use `HtmlProperties.Custom`
docs/generators/partials/header.fsx	Bump Fornax.Core reference
docs/generators/partials/footer.fsx	Bump Fornax.Core reference; use `HtmlProperties.Custom`
docs/generators/page.fsx	Bump Fornax.Core reference
docs/generators/lunr.fsx	Migrate to new ApiDocs model; switch JSON serialization
docs/generators/apiref.fsx	Migrate templates/code to `ApiDocs` types and APIs
docs/config.fsx	Bump Fornax.Core reference
.config/dotnet-tools.json	Update `fornax` tool version to 0.15.1

Comments suppressed due to low confidence (1)

docs/generators/apiref.fsx:199

[nitpick] This heading says "Declared Modules" but you’re iterating over n.Entities, which may include both modules and types. Either filter to only modules or update the label to accurately reflect what is being listed (e.g. "Declared Entities").

                b [] [!! "Declared Modules"]

docs/generators/apiref.fsx

xperiandri · 2025-07-07T09:41:54Z

@Numpsy I’ve migrated to the farnax 0.15.1.
Not latest as latest need 9.0.300
Maybe targeting 9.0.300 everywhere will work.
I had issues with deserialization in another project, hence not migrated to 9.0.300

knocte · 2025-07-07T09:46:23Z

Good work! But let's not merge this until CI is green.

I believe the deployReleaseBinaries problem will be fixed by #737. After I merge it, you could rebase this PR and then it will have full green CI.

knocte · 2025-07-07T10:31:41Z

I believe the deployReleaseBinaries problem will be fixed by #737. After I merge it, you could rebase this PR and then it will have full green CI.

Merged! Can you rebase @xperiandri ? After that CI should be green.
Thanks!

Numpsy · 2025-07-07T10:46:34Z

@Numpsy I had issues with deserialization in another project

You mean dotnet/fsharp#18596 or something else?

xperiandri · 2025-07-07T11:00:42Z

@Numpsy Yes, exactly that one

xperiandri · 2025-07-07T11:01:18Z

@knocte the PR is not yet ready to merge

knocte · 2025-07-07T12:30:47Z

You mean dotnet/fsharp#18596 or something else?

Should we revert the migration from Newtonsoft to System.Text.Json then? Feels like it was to early to do that.

docs/generators/apiref.fsx

Numpsy · 2025-07-07T15:42:25Z

If I run the FAKE 'docs' task on a clean source tree then I get this from the build, because it seems like the dlls only exist in the 'build' directory under the root of the source tree:

and the CI seems to be the same - https://github.com/fsprojects/FSharpLint/actions/runs/16109933504/job/45452089298#step:7:61

If I do a full build of everything first then I get

and the API docs are empty

xperiandri · 2025-07-07T16:03:36Z

I call dotnet tool run fornax within the docs folder and it works

Numpsy · 2025-07-07T17:49:19Z

Hmm, looks like the 'Docs' target in build.fsx runs the 'BuildRelease' target, which sets the output directory for the build to ./build/, so if that's the only target which has been run (as I think happens in the CI), then the dlls aren't in the FSharpLint.Core\bin folder where apirefloader.fsx is looking?

Numpsy · 2025-07-07T22:50:03Z

fwiw, I opened ionide/Fornax#125 to see if it'd be possible to get a build of Fornax that could be used with FSharp.Formatting v20, rather than needing to keep it at v16

xperiandri · 2025-07-07T23:07:56Z

In the latest update I removed that, now everything is built locally

knocte · 2025-07-08T05:24:52Z

@xperiandri: couple of things:

can you please expand the commit msg of the "revert: mindsers/changelog-reader-action@v1" to explain the motivation for it? (the why, not the what)
can you squash the "fixup! feat(ci): update all GitHub actions" commit with the "feat(ci): update all GitHub actions" one?

Thanks

docs/loaders/apirefloader.fsx

.github/workflows/build+test+deploy.yml

xperiandri · 2025-07-08T20:39:44Z

If there are no more remarks, I propose to merge this.
And when TheAngryByrd merges Numpsy's Fornax update to 8.0 and then to 9.0 we update Fornax here

docs/loaders/apirefloader.fsx

ribeirotomas1904 · 2025-07-09T08:41:59Z

If there are no more remarks, I propose to merge this. And when TheAngryByrd merges Numpsy's Fornax update to 8.0 and then to 9.0 we update Fornax here

It seems the API documentation it's still not being generated: https://github.com/fsprojects/FSharpLint/actions/runs/16157972424/job/45604599421?pr=736#step:6:76

Numpsy · 2025-07-09T14:39:52Z

If there are no more remarks, I propose to merge this. And when TheAngryByrd merges Numpsy's Fornax update to 8.0 and then to 9.0 we update Fornax here

It seems the API documentation it's still not being generated: https://github.com/fsprojects/FSharpLint/actions/runs/16157972424/job/45604599421?pr=736#step:6:76

There's a chain of old stuff that needs updating - it seems that the compiler tools used by the old versions of Fornax can't read the current assemblies (may or may not be related fo compressed metadata in FSharp.Core, not sure) - I've got that updated and just got a local build using Fornax 0.16 and FSharp.Formatting 20.0.1 -

Numpsy · 2025-07-09T14:44:00Z

As it stands I get this

But with the mdcomments flag I mentioned before I get this

xperiandri · 2025-07-09T14:44:52Z

I tried but not got the result.
Could you push your branch?

Numpsy · 2025-07-09T15:08:39Z

I tried but not got the result. Could you push your branch?

Numpsy@3736e1f
https://github.com/Numpsy/FSharpLint/actions/runs/16172643991/job/45651224510#step:6:69

knocte · 2025-07-10T09:25:18Z

docs/loaders/pageloader.fsx

@@ -1,5 +1,4 @@
-#r "../_lib/Fornax.Core.dll"
-
+#r "nuget: Fornax.Core, 0.15.1"


@xperiandri given that last version of this PR is targetting Fornax 0.16.x, I guess these refs need to be updated too? Also PR title.

…ng` to `20.0.1`

@xperiandri

## [0.25.0] - 2025-07-11 - Migrate from `Paket` to `Directory.Packages.props` #722 [@xperiandri] - Migrate to .NET `9.0.201` and FCS `43.9.201` #722 [@xperiandri] - Write test logs to test context output #722 [@xperiandri] - Use string interpolation instead of `+` concatenation #724 [@xperiandri] - Run tests in parallel #728 [@xperiandri] - Remove `NoPartialFunctions` compiler workaround (#698) [@webwarrior-ws] - Add `SLNX` and `SLNF` format support and migrate to SLNX solution #723 [@xperiandri] Remove `Ionide.ProjInfo.Sln` NuGet package dependency - Remove `Newtonsoft.Json` NuGet dependency #725 [@xperiandri] - Add missing rule checks for FL0079-FL0081 #713 [@BennieCopeland] - Modify `.gitignore` to the Visual Studio standard one #735 [@xperiandri] - Add basic Copilot instructions and GitHub MCP #726 [@xperiandri] - Migrate `Fornax` to `0.16.0-beta002` and `FSharp.Formatting` to `20.0.1` #736 [@xperiandri, @Numpsy] - Update the build instructions to use `dotnet fsi` instead of `fake-cli` #734 [@Numpsy]

Recent fix [1] for our scheduled CI build didn't last long. Suddenly the "Restore tools" step (`dotnet tool restore`) started failing in Linux because the GithubActions agent's dotnet version was apparently upgraded from 9.0.306 to 9.0.307. Given this, the most sensible approach to fix this is revisit our RollForward policy, which was disabled in a recent PR [2] because of apparent issues when upgrading our docs generation. That issue seems to not be happenning anymore because our CIs are green even when we upgraded to a .NET version newer than 9.0.300 (maybe thanks to our Fornax dependency upgrade?), so it seems safe to restore to a "Minor" setting here. [1] fsprojects#780 [2] fsprojects#736

Recent fix [1] for our scheduled CI build didn't last long. Suddenly the "Restore tools" step (`dotnet tool restore`) started failing in Linux because the GithubActions agent's dotnet version was apparently upgraded from 9.0.306 to 9.0.307. Given this, the most sensible approach to fix this is revisit our RollForward policy, which was disabled in a recent PR [2] because of apparent issues when upgrading our docs generation. That issue seems to not be happenning anymore because our CIs are green even when we upgraded to a .NET version newer than 9.0.300 (maybe thanks to our Fornax dependency upgrade?), so it seems safe to restore to a "Minor" setting here. [1] #780 [2] #736

Copilot AI review requested due to automatic review settings July 7, 2025 04:47

Copilot AI reviewed Jul 7, 2025

View reviewed changes

docs/generators/apiref.fsx Outdated Show resolved Hide resolved

xperiandri force-pushed the fornax-0.15.1 branch 3 times, most recently from d457f7c to 5bbf5f2 Compare July 7, 2025 06:27

knocte mentioned this pull request Jul 7, 2025

build.fsx: only push Nuget packages from master branch #737

Merged

knocte mentioned this pull request Jul 7, 2025

build.fsx: fix working dir when uploading nugets #738

Merged

xperiandri commented Jul 7, 2025

View reviewed changes

docs/generators/apiref.fsx Show resolved Hide resolved

xperiandri force-pushed the fornax-0.15.1 branch from 1edfc01 to 8bd77ad Compare July 7, 2025 16:59

Numpsy mentioned this pull request Jul 7, 2025

[RFC] Update FSharp.Compiler.Service to 43.8 ionide/Fornax#125

Closed

knocte reviewed Jul 8, 2025

View reviewed changes

docs/loaders/apirefloader.fsx Outdated Show resolved Hide resolved

webwarrior-ws reviewed Jul 8, 2025

View reviewed changes

.github/workflows/build+test+deploy.yml Outdated Show resolved Hide resolved

xperiandri force-pushed the fornax-0.15.1 branch from 8bd77ad to 2d6a6ec Compare July 8, 2025 13:46

Numpsy mentioned this pull request Jul 8, 2025

Update all the things ionide/Fornax#127

Merged

Numpsy reviewed Jul 8, 2025

View reviewed changes

docs/loaders/apirefloader.fsx Outdated Show resolved Hide resolved

xperiandri force-pushed the fornax-0.15.1 branch from 44a029d to 0c501ed Compare July 9, 2025 01:16

xperiandri commented Jul 9, 2025

View reviewed changes

docs/loaders/apirefloader.fsx Outdated Show resolved Hide resolved

knocte reviewed Jul 10, 2025

View reviewed changes

xperiandri and others added 5 commits July 10, 2025 16:34

feat(docs): migrate Fornax to 0.15.1

b6497fa

fix(docs): reference resolution and missing site info

eada852

feat(ci): signal the pipeline that docs generation failed

26f7c9f

refactor(docs): simplify generateNamespace funtions usage

aaabc34

feat(docs): migrate Fornax to 0.16.0-beta002 and `FSharp.Formatti…

b173d9f

…ng` to `20.0.1`

xperiandri force-pushed the fornax-0.15.1 branch from 53634ab to b173d9f Compare July 10, 2025 12:40

xperiandri changed the title ~~Migrated Fornax to 0.15.1~~ Migrated Fornax to 0.16.0-beta002 Jul 10, 2025

xperiandri merged commit 8cff1f2 into master Jul 10, 2025
10 checks passed

Numpsy mentioned this pull request Jul 10, 2025

Try to get the docs building with NuGet instead of Paket #733

Closed

xperiandri deleted the fornax-0.15.1 branch July 18, 2025 10:09

Numpsy mentioned this pull request Nov 13, 2025

Fix build failures when building with the .NET 10 SDK #779

Closed

knocte mentioned this pull request Nov 14, 2025

global.json: relax rollForward policy to fix CI #783

Merged

		@@ -1,5 +1,4 @@
		#r "../_lib/Fornax.Core.dll"

		#r "nuget: Fornax.Core, 0.15.1"

Migrated Fornax to 0.16.0-beta002 #736

Migrated Fornax to 0.16.0-beta002 #736

Uh oh!

Conversation

xperiandri commented Jul 7, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

xperiandri commented Jul 7, 2025

Uh oh!

knocte commented Jul 7, 2025

Uh oh!

knocte commented Jul 7, 2025

Uh oh!

Numpsy commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xperiandri commented Jul 7, 2025

Uh oh!

xperiandri commented Jul 7, 2025

Uh oh!

knocte commented Jul 7, 2025

Uh oh!

Uh oh!

Numpsy commented Jul 7, 2025

Uh oh!

xperiandri commented Jul 7, 2025

Uh oh!

Numpsy commented Jul 7, 2025

Uh oh!

Numpsy commented Jul 7, 2025

Uh oh!

xperiandri commented Jul 7, 2025

Uh oh!

knocte commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

xperiandri commented Jul 8, 2025

Uh oh!

Uh oh!

Uh oh!

ribeirotomas1904 commented Jul 9, 2025

Uh oh!

Numpsy commented Jul 9, 2025

Uh oh!

Numpsy commented Jul 9, 2025

Uh oh!

xperiandri commented Jul 9, 2025

Uh oh!

Numpsy commented Jul 9, 2025

Uh oh!

knocte Jul 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Migrated `Fornax` to `0.16.0-beta002` #736

Migrated `Fornax` to `0.16.0-beta002` #736

Numpsy commented Jul 7, 2025 •

edited

Loading

knocte commented Jul 8, 2025 •

edited

Loading