Skip to content
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.

Sign up for GitHub

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

strict build of docs #971

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

strict build of docs #971

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2545d74
update
dsyme Aug 30, 2022
ad71950
update
dsyme Aug 30, 2022
731d9a6
update
dsyme Aug 30, 2022
7b34095
Merge branch 'upd3' of https://github.com/fsharp/fsharp-compiler-docs…
dsyme Aug 30, 2022
071b9c6
two sdk
dsyme Aug 30, 2022
9bc6146
Merge branch 'main' of https://github.com/fsharp/fsharp-compiler-docs…
dsyme Aug 30, 2022
aab3f4f
Merge branch 'main' of https://github.com/fsharp/fsharp-compiler-docs…
dsyme Aug 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .config/dotnet-tools.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"isRoot": true,
"tools": {
"fsdocs-tool": {
"version": "14.0.1",
"version": "16.0.2",
"commands": [
"fsdocs"
]
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Setup .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: 5.0.400
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of having to keep these versions up to date, if you have a global.json file in this repo you can update these actions to be:

- name: Setup .NET Core
  uses: action/setup-dotnet@v2

and the action will use the version constraints from the global.json, keeping them in sync from that point onward.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we need two sdks unfortunately, but it's all a bit messy. FsDocs likes to run with .NET 6 and we're currently building docs from "main" of dotnet/fsahrp, which likes whatever .NET 7 preview it's on.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not even totally sure this separate docs build is worth it tbh, but if we want generated docs the only other solution would be to generate within dotnet/fsharp itself. But that would probably lead to integrating all of FSharp.Formatting into dotnet/fsharp, which is a big hit, leading to more and more monorepo. Perhaps it's what we should do.

dotnet-version: 6.0.203
- name: Restore tools
run: dotnet tool restore
- name: Restore projects
Expand All @@ -28,7 +28,7 @@ jobs:
- name: Build fsharp master (turn of CI build status)
run: cd fsharp && eng\CIBuild.cmd -noVisualStudio
- name: Run fsdocs
run: dotnet fsdocs build --sourcefolder fsharp --input fsharp/docs
run: dotnet fsdocs build --sourcefolder fsharp --input fsharp/docs --strict
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ jobs:
strategy:
matrix:
os: [windows-latest]
dotnet: [5.0.400]
dotnet: [6.0.203]
runs-on: ${{ matrix.os }}

steps:
- uses: actions/checkout@v2
- name: Setup .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: 5.0.400
dotnet-version: 6.0.203
- name: Restore tools
run: dotnet tool restore
- name: Restore projects
Expand All @@ -29,4 +29,4 @@ jobs:
- name: Build fsharp master (turn of CI build status)
run: cd fsharp && eng\CIBuild.cmd -noVisualStudio
- name: Run fsdocs
run: dotnet fsdocs build --sourcefolder fsharp --input fsharp/docs
run: dotnet fsdocs build --sourcefolder fsharp --input fsharp/docs --strict