Skip to content

Commit b8b980d

Browse files
authored
Merge pull request #13360 from lampepfl/backport-scaladoc-test-fixes
Backport scaladoc test fixes
2 parents b90fad7 + 6ad7540 commit b8b980d

File tree

4 files changed

+41
-25
lines changed

4 files changed

+41
-25
lines changed

.github/workflows/scaladoc.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ jobs:
3939
run: ./project/scripts/sbt scaladoc-js/test
4040

4141
- name: Compile and test
42-
run: ./project/scripts/sbt scaladoc/test
42+
run: |
43+
./project/scripts/sbt scaladoc/test
44+
./project/scripts/cmdScaladocTests
4345
4446
- name: Locally publish self
4547
run: ./project/scripts/sbt scaladoc/publishLocal

project/Build.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -1245,7 +1245,7 @@ object Build {
12451245
val distLocation = (dist / pack).value
12461246
val projectVersion = version.value
12471247
IO.createDirectory(file(outDir))
1248-
val stdLibVersion = stdlibVersion(Bootstrapped)
1248+
val stdLibVersion = stdlibVersion(NonBootstrapped)
12491249
val scalaLib = findArtifactPath(externalCompilerClasspathTask.value, "scala-library")
12501250
val dottyLib = (`scala3-library` / Compile / classDirectory).value
12511251
// TODO add versions etc.

project/scripts/cmdScaladocTests

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#!/usr/bin/env bash
2+
3+
source $(dirname $0)/cmdTestsCommon.inc.sh
4+
5+
echo "testing scaladoc script"
6+
clear_out "$OUT"
7+
clear_out "$OUT1"
8+
9+
10+
STDLIB_COMMAND="$SBT \"eval println(Build.stdlibVersion(Modes.NonBootstrapped))\""
11+
STDLIB_VERSION=$(eval $STDLIB_COMMAND | tail -n 2 | head -n 1)
12+
13+
DOTTY_NONBOOTSTRAPPED_VERSION_COMMAND="$SBT \"eval println(Build.dottyNonBootstrappedVersion)\""
14+
DOTTY_NONBOOTSTRAPPED_VERSION=$(eval $DOTTY_NONBOOTSTRAPPED_VERSION_COMMAND | tail -n 2 | head -n 1)
15+
16+
DOTTY_BOOTSTRAPPED_VERSION_COMMAND="$SBT \"eval println(Build.dottyVersion)\""
17+
DOTTY_BOOTSTRAPPED_VERSION=$(eval $DOTTY_BOOTSTRAPPED_VERSION_COMMAND | tail -n 2 | head -n 1)
18+
19+
"$SBT" "scaladoc/generateTestcasesDocumentation" > "$tmp" 2>&1 || echo "generated testcases project with sbt"
20+
dist/target/pack/bin/scaladoc \
21+
-d "$OUT1" \
22+
-project "scaladoc testcases" \
23+
-source-links:out/bootstrap/stdlib-bootstrapped/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/src_managed/main/scala-library-src=github://scala/scala/v"${STDLIB_VERSION}"#src/library \
24+
-source-links:out/bootstrap/stdlib-bootstrapped/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/src_managed/main/dotty-library-src=github://"${GITHUB_REPOSITORY}"/"${GITHUB_SHA}"\#library/src \
25+
-source-links:github://"${GITHUB_REPOSITORY}"/"${GITHUB_SHA}" \
26+
"-external-mappings:.*scala.*::scaladoc3::https://dotty.epfl.ch/api/,.*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/" \
27+
"-skip-by-regex:.+\.internal($|\..+)" \
28+
"-skip-by-regex:.+\.impl($|\..+)" \
29+
-project-logo docs/logo.svg \
30+
-social-links:github::https://github.com/lampepfl/dotty,gitter::https://gitter.im/scala/scala,twitter::https://twitter.com/scala_lang \
31+
-Ygenerate-inkuire \
32+
"-skip-by-id:scala.runtime.stdLibPatches" \
33+
"-skip-by-id:scala.runtime.MatchCase" \
34+
-project-footer "Copyright (c) 2002-2021, LAMP/EPFL" \
35+
-author -groups -revision master -project-version "${DOTTY_BOOTSTRAPPED_VERSION}" \
36+
out/bootstrap/scaladoc-testcases/scala-"${DOTTY_NONBOOTSTRAPPED_VERSION}"/classes > "$tmp" 2>&1 || echo "generated testcases project with scripts"
37+
diff -rq "$OUT1" "scaladoc/output/testcases"

project/scripts/cmdTests

-23
Original file line numberDiff line numberDiff line change
@@ -61,29 +61,6 @@ echo "testing -Ythrough-tasty"
6161
clear_out "$OUT"
6262
"$SBT" ";scalac -Ythrough-tasty $SOURCE"
6363

64-
echo "testing scaladoc script"
65-
clear_out "$OUT"
66-
clear_out "$OUT1"
67-
"$SBT" "scaladoc/generateTestcasesDocumentation" > "$tmp" 2>&1 || echo "generated testcases project with sbt"
68-
dist/target/pack/bin/scaladoc \
69-
-d "$OUT1" \
70-
-project "scaladoc testcases" \
71-
-source-links:out/bootstrap/stdlib-bootstrapped/scala-3.0.2-RC1-bin-SNAPSHOT-nonbootstrapped/src_managed/main/scala-library-src=github://scala/scala/v2.13.6#src/library \
72-
-source-links:out/bootstrap/stdlib-bootstrapped/scala-3.0.2-RC1-bin-SNAPSHOT-nonbootstrapped/src_managed/main/dotty-library-src=github://"${GITHUB_REPOSITORY}"/"${GITHUB_SHA}"\#library/src \
73-
-source-links:github://"${GITHUB_REPOSITORY}"/"${GITHUB_SHA}" \
74-
"-external-mappings:.*scala.*::scaladoc3::https://dotty.epfl.ch/api/,.*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/" \
75-
"-skip-by-regex:.+\.internal($|\..+)" \
76-
"-skip-by-regex:.+\.impl($|\..+)" \
77-
-project-logo docs/logo.svg \
78-
-social-links:github::https://github.com/lampepfl/dotty,gitter::https://gitter.im/scala/scala,twitter::https://twitter.com/scala_lang \
79-
-Ygenerate-inkuire \
80-
"-skip-by-id:scala.runtime.stdLibPatches" \
81-
"-skip-by-id:scala.runtime.MatchCase" \
82-
-project-footer "Copyright (c) 2002-2021, LAMP/EPFL" \
83-
-author -groups -revision master -project-version 3.0.2-RC1-bin-SNAPSHOT \
84-
out/bootstrap/scaladoc-testcases/scala-3.0.2-RC1-bin-SNAPSHOT-nonbootstrapped/classes > "$tmp" 2>&1 || echo "generated testcases project with scripts"
85-
diff -rq "$OUT1" "scaladoc/output/testcases"
86-
8764
## Disabled because of flakeyness, should be changed to not depend on sbt
8865
# echo "running Vulpix meta test"
8966
# tmp=$(mktemp)

0 commit comments

Comments
 (0)