Skip to content

Commit b9be246

Browse files
committed
docc validation needs JAVA_HOME to be set up
1 parent 0d5dcb7 commit b9be246

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.github/workflows/pull_request.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,32 @@ jobs:
1313
# FIXME: Something is off with the format task and it gets "stuck", need to investigate
1414
format_check_enabled: false
1515
license_header_check_project_name: Swift.org
16+
# Since we need JAVA_HOME to be set up for building the project and depending on a different workflow won't
17+
# give us that, we disable the checking and make a separate job that performs docs validation
18+
docs_check_enabled: false
19+
20+
# This replicates 'docs-check' from https://github.com/swiftlang/github-workflows/blob/main/.github/workflows/soundness.yml
21+
# because we need to set up environment so we can build the SwiftJava project (including Java runtime/dependencies).
22+
soundness-docs:
23+
name: Documentation check
24+
runs-on: ubuntu-latest
25+
strategy:
26+
fail-fast: true
27+
matrix:
28+
swift_version: ['6.1.2']
29+
os_version: ['jammy']
30+
jdk_vendor: ['corretto']
31+
container:
32+
image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
33+
steps:
34+
- uses: actions/checkout@v4
35+
- name: Prepare CI Environment
36+
uses: ./.github/actions/prepare_env
37+
- name: Run documentation check
38+
run: |
39+
which curl yq || (apt -q update && apt -yq install curl yq)
40+
curl -s --retry 3 https://raw.githubusercontent.com/swiftlang/github-workflows/refs/heads/main/.github/workflows/scripts/check-docs.sh | bash
41+
1642
1743
test-java:
1844
name: Test (Java) (${{ matrix.os_version }} swift:${{ matrix.swift_version }} jdk:${{matrix.jdk_vendor}})

0 commit comments

Comments
 (0)