Skip to content

Commit c40a672

Browse files
authored
Bump DocFx version to support latest language features (#88)
1 parent 30d4865 commit c40a672

File tree

3 files changed

+39
-26
lines changed

3 files changed

+39
-26
lines changed

Diff for: apidocs/docfx.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
"disableDefaultFilter": false,
1515
"noRestore": false,
1616
"namespaceLayout": "flattened",
17-
"memberLayout": "samePage",
17+
"memberLayout": "separatePages",
18+
"EnumSortOrder": "declaringOrder",
1819
"allowCompilationErrors": false
1920
}
2021
],

Diff for: evergreen/build-apidocs.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ echo "Configure dotnet cli to use local manifest"
1010
dotnet new tool-manifest --force
1111

1212
echo "Installing docfx tool"
13-
dotnet tool install docfx --version "2.72.1" --local --verbosity q
13+
dotnet tool install docfx --version "2.76.0" --local --verbosity q
1414

1515
echo "Building the api-docs"
1616
dotnet tool run docfx metadata ./apidocs/docfx.json --property ProduceReferenceAssembly=true

Diff for: evergreen/evergreen.yml

+36-24
Original file line numberDiff line numberDiff line change
@@ -224,6 +224,7 @@ functions:
224224
225225
pack-packages:
226226
- command: shell.exec
227+
type: test
227228
params:
228229
working_dir: mongo-efcore-provider
229230
script: |
@@ -232,6 +233,7 @@ functions:
232233
233234
packages-smoke-tests:
234235
- command: shell.exec
236+
type: test
235237
params:
236238
working_dir: mongo-efcore-provider
237239
script: |
@@ -244,6 +246,7 @@ functions:
244246
245247
push-packages:
246248
- command: shell.exec
249+
type: test
247250
params:
248251
working_dir: mongo-efcore-provider
249252
env:
@@ -291,19 +294,17 @@ functions:
291294

292295
build-apidocs:
293296
- command: shell.exec
297+
type: test
294298
params:
295299
shell: bash
296300
working_dir: mongo-efcore-provider
297301
script: |
298302
${PREPARE_SHELL}
299-
if ! [[ "$PACKAGE_VERSION" =~ ^[0-9]+\.[0-9]+\.0$ ]]; then
300-
echo "Skip api docs generating for the patch release"
301-
exit 0
302-
fi
303303
./evergreen/build-apidocs.sh
304304
305305
upload-apidocs:
306306
- command: shell.exec
307+
type: test
307308
params:
308309
shell: bash
309310
working_dir: mongo-efcore-provider
@@ -313,8 +314,8 @@ functions:
313314
script: |
314315
${PREPARE_SHELL}
315316
if ! [[ "$PACKAGE_VERSION" =~ ^[0-9]+\.[0-9]+\.0$ ]]; then
316-
echo "Skip api docs generating for the patch release"
317-
exit 0
317+
echo "Cannot upload api docs generating for the patch release"
318+
exit 1
318319
fi
319320
./evergreen/upload-apidocs.sh
320321
@@ -352,6 +353,10 @@ tasks:
352353
PACKAGE_ID: "MongoDB.EntityFrameworkCore"
353354
- func: packages-smoke-tests
354355

356+
- name: validate-apidocs
357+
commands:
358+
- func: build-apidocs
359+
355360
- name: generate-apidocs
356361
commands:
357362
- func: build-apidocs
@@ -461,8 +466,6 @@ buildvariants:
461466
build-target: "tests"
462467
display_name: "${target_runtime} ${driver} Driver on ${os} with ${version} Server"
463468
tags: ["tests-variant"]
464-
expansions:
465-
BUILD_TARGET: "tests"
466469
tasks:
467470
- name: main-tests
468471

@@ -475,11 +478,18 @@ buildvariants:
475478
display_name: "${target_runtime} ${driver} Driver on Ubuntu-1804 with ${version} Server"
476479
run_on: ubuntu1804-small
477480
tags: ["tests-variant"]
478-
expansions:
479-
BUILD_TARGET: "tests"
480481
tasks:
481482
- name: main-tests
482483

484+
- matrix_name: validate-apidocs
485+
matrix_spec:
486+
build-target: "tests"
487+
display_name: "Validate API Documentation generation"
488+
run_on: ubuntu2004-small
489+
tags: ["generate-apidocs", "tests-variant"]
490+
tasks:
491+
- name: validate-apidocs
492+
483493
- matrix_name: pack-packages
484494
matrix_spec:
485495
build-target: "release"
@@ -489,6 +499,7 @@ buildvariants:
489499
tasks:
490500
- name: pack-packages
491501
git_tag_only: true
502+
priority: 10
492503

493504
- matrix_name: test-packages
494505
matrix_spec:
@@ -502,22 +513,24 @@ buildvariants:
502513
tasks:
503514
- name: packages-tests
504515
git_tag_only: true
516+
priority: 10
505517
depends_on:
506518
- name: pack-packages
507519
variant: .pack-packages
508520

509-
#- matrix_name: generate-apidocs
510-
# matrix_spec:
511-
# build-target: "release"
512-
# display_name: "Generate API Documentation"
513-
# run_on: ubuntu2004-small
514-
# tags: ["generate-apidocs", "release_tag"]
515-
# tasks:
516-
# - name: generate-apidocs
517-
# git_tag_only: true
518-
# depends_on:
519-
# - name: packages-tests
520-
# variant: .package-tests
521+
- matrix_name: generate-apidocs
522+
matrix_spec:
523+
build-target: "release"
524+
display_name: "Generate API Documentation"
525+
run_on: ubuntu2004-small
526+
tags: ["generate-apidocs", "release_tag"]
527+
tasks:
528+
- name: generate-apidocs
529+
git_tag_only: true
530+
priority: 10
531+
depends_on:
532+
- name: packages-tests
533+
variant: .package-tests
521534

522535
- matrix_name: push-packages
523536
matrix_spec:
@@ -528,10 +541,9 @@ buildvariants:
528541
tasks:
529542
- name: push-packages
530543
git_tag_only: true
544+
priority: 10
531545
depends_on:
532546
- name: pack-packages
533547
variant: .pack-packages
534548
- name: packages-tests
535549
variant: .package-tests
536-
# - name: generate-apidocs
537-
# variant: .generate-apidocs

0 commit comments

Comments
 (0)