Skip to content

Commit 5f5dfa1

Browse files
committed
Updated docs build for automation.
- Added more logging to figure out why it is complaining that the analyzer isn't built... - Updated spelling dictionary
1 parent c4b78df commit 5f5dfa1

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

.github/workflows/pr-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
fetch-depth: 0
6565

6666
- name: Build Docs
67-
run: .\Build-All.ps1 -ForceClean -BuildMode Docs
67+
run: .\Build-All.ps1 -ForceClean -BuildMode Docs -FullInit
6868

6969
- name: Upload docs artifact
7070
uses: actions/upload-artifact@v4

Build-Docs.ps1

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,12 +111,17 @@ try
111111

112112
if($buildInfo["IsAutomatedBuild"])
113113
{
114+
Write-Information "Building analyzer so it is available when building docs."
114115
# In automated builds the analyzer doesn't exist yet and it isn't listed in the docfx.json so that won't
115116
# build it either. There's nothing to document (at this point it is entirely internal). So it MUST be built
116117
# directly to support automated builds.
117118
$analyzerProjPath = Join-Path 'src' 'ReferenceEqualityVerifier' 'ReferenceEqualityVerifier' 'ReferenceEqualityVerifier.csproj'
118119
Invoke-External dotnet build '--tl:off' $analyzerProjPath '-c' $Configuration
119120
}
121+
else
122+
{
123+
Write-Information "Not an automated build; assuming analyzer already built"
124+
}
120125

121126
$fullBuildNumber = Get-FullBuildNumber
122127
push-location './docfx'

IgnoredWords.dic

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ buildbinoutput
2323
buildtransitive
2424
builtinop
2525
byref
26+
byval
2627
cibuild
2728
Cmp
2829
Config
@@ -61,20 +62,25 @@ llvm
6162
llvmversion
6263
LValue
6364
marshalling
65+
memcopy
6466
metadata
6567
Mips
6668
msbuild
6769
msg
6870
nav
71+
noinline
72+
nounwind
6973
nullability
7074
Nullable
75+
optimizenone
7176
pages
7277
paren
7378
perf
7479
pointee
7580
Pre
7681
proj
7782
readonly
83+
refactor
7884
repl
7985
repo
8086
RMW

0 commit comments

Comments
 (0)