Skip to content

Fail docfx on invalid internal link #1681

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

Merged
merged 1 commit into from
Feb 15, 2025
Merged

Fail docfx on invalid internal link #1681

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ jobs:
run: |
cd docs
& ./generate-examples.ps1
dotnet docfx docfx.json
dotnet docfx docfx.json --warningsAsErrors true
if ($LastExitCode -ne 0) {
Write-Error "docfx failed with exit code $LastExitCode."
}
Expand Down
2 changes: 1 addition & 1 deletion docs/build-dev.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ if (-Not $NoBuild -Or -Not (Test-Path -Path _site)) {
dotnet tool restore
VerifySuccessExitCode

dotnet docfx ./docfx.json
dotnet docfx ./docfx.json --warningsAsErrors true
VerifySuccessExitCode

Copy-Item -Force home/*.html _site/
Expand Down
110 changes: 62 additions & 48 deletions docs/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,67 @@
{
"metadata": [
"metadata": [
{
"properties": {
"ProduceReferenceAssembly": "true"
},
"src": [
{
"src": [
{
"files": [ "**/JsonApiDotNetCore.csproj","**/JsonApiDotNetCore.Annotations.csproj" ],
"src": "../"
}
],
"dest": "api",
"disableGitFeatures": false
"files": [
"**/JsonApiDotNetCore.csproj",
"**/JsonApiDotNetCore.Annotations.csproj"
],
"src": "../"
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md",
"getting-started/**.md",
"getting-started/**/toc.yml",
"usage/**.md",
"request-examples/**.md",
"internals/**.md",
"toc.yml",
"*.md"
],
"exclude": [
"**/README.md"
]
}
],
"resource": [
{
"files": [ "diagrams/*.svg" ]
}
],
"overwrite": [
{
"exclude": [ "obj/**", "_site/**" ]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [ "default", "modern" ],
"postProcessors": [],
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
],
"dest": "api",
"disableGitFeatures": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"api/index.md",
"getting-started/**.md",
"getting-started/**/toc.yml",
"usage/**.md",
"request-examples/**.md",
"internals/**.md",
"toc.yml",
"*.md"
],
"exclude": [
"**/README.md"
]
}
],
"resource": [
{
"files": [
"diagrams/*.svg"
]
}
],
"overwrite": [
{
"exclude": [
"obj/**",
"_site/**"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default",
"modern"
],
"postProcessors": [],
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
Loading