Docs: provide option to skip analysis in doc-check #644
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Pull request | |
| permissions: | |
| contents: read | |
| on: | |
| pull_request: | |
| types: [opened, reopened, synchronize] | |
| jobs: | |
| tests_with_docker_embedded_swift: | |
| name: Test Embedded Swift SDKs | |
| uses: ./.github/workflows/swift_package_test.yml | |
| with: | |
| # Wasm | |
| enable_linux_checks: false | |
| enable_macos_checks: false | |
| enable_windows_checks: false | |
| wasm_sdk_pre_build_command: | | |
| cd tests/TestPackage | |
| enable_embedded_wasm_sdk_build: true | |
| tests_with_docker: | |
| name: Test with Docker | |
| uses: ./.github/workflows/swift_package_test.yml | |
| with: | |
| # Linux | |
| linux_os_versions: '["jammy", "rhel-ubi9", "amazonlinux2"]' | |
| linux_host_archs: '["x86_64", "aarch64"]' | |
| linux_build_command: | | |
| cd tests/TestPackage | |
| swift build | |
| linux_static_sdk_pre_build_command: | | |
| cd tests/TestPackage | |
| enable_linux_static_sdk_build: true | |
| # Wasm | |
| wasm_sdk_pre_build_command: | | |
| cd tests/TestPackage | |
| enable_wasm_sdk_build: true | |
| # Windows | |
| windows_build_command: | | |
| cd tests/TestPackage | |
| Invoke-Program swift build | |
| enable_windows_docker: true | |
| tests_without_docker: | |
| name: Test without Docker | |
| uses: ./.github/workflows/swift_package_test.yml | |
| with: | |
| # Skip Linux which doesn't currently support docker-less workflow | |
| enable_linux_checks: false | |
| # Android | |
| android_sdk_pre_build_command: | | |
| cd tests/TestPackage | |
| enable_android_sdk_build: true | |
| enable_android_sdk_checks: true | |
| android_ndk_versions: "[\"r28c\"]" | |
| # Windows | |
| windows_build_command: | | |
| cd tests/TestPackage | |
| Invoke-Program swift build | |
| enable_windows_docker: false | |
| windows_os_versions: '["windows-2022", "windows-11-arm"]' | |
| # FreeBSD | |
| enable_freebsd_checks: true | |
| freebsd_pre_build_command: | | |
| cd tests/TestPackage | |
| tests_macos: | |
| name: Test | |
| uses: ./.github/workflows/swift_package_test.yml | |
| with: | |
| enable_linux_checks: false | |
| enable_windows_checks: false | |
| # macOS | |
| enable_macos_checks: true | |
| macos_build_command: | | |
| cd tests/TestPackage | |
| xcrun swift build | |
| build_tests_ios: | |
| name: Build iOS Tests | |
| uses: ./.github/workflows/swift_package_test.yml | |
| with: | |
| enable_linux_checks: false | |
| enable_windows_checks: false | |
| # iOS | |
| enable_ios_checks: true | |
| ios_build_command: | | |
| cd tests/TestPackage | |
| xcodebuild -quiet -scheme TestPackage-Package -destination "generic/platform=ios" build | |
| soundness: | |
| name: Soundness | |
| uses: ./.github/workflows/soundness.yml | |
| with: | |
| api_breakage_check_enabled: false | |
| license_header_check_project_name: "Swift.org" | |
| soundness-docs: | |
| name: "Soundness - Docs (override_target: ${{ matrix.override_target }} ; SPI yml exists: ${{ matrix.spi_yml_exists }})" | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| override_target: [true, false] | |
| spi_yml_exists: [true, false] | |
| uses: ./.github/workflows/soundness.yml | |
| with: | |
| linux_pre_build_command: "cd tests/TestPackage && ${{ case(matrix.spi_yml_exists, 'cat .spi.yml', 'rm -rf .spi.yml') }}" | |
| docs_check_enabled: true | |
| docs_check_targets: ${{ case(matrix.override_target, 'theDocs', '')}} | |
| docs_check_macos_enabled: false | |
| api_breakage_check_enabled: false | |
| unacceptable_language_check_enabled: false | |
| license_header_check_enabled: false | |
| broken_symlink_check_enabled: false | |
| format_check_enabled: false | |
| shell_check_enabled: false | |
| yamllint_check_enabled: false | |
| python_lint_check_enabled: false |