Skip to content

GHA: wire up build of swift-docc #1052

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

GHA: wire up build of swift-docc #1052

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/build-toolchain.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,9 @@ jobs:
swift_corelibs_libdispatch_revision: ${{ steps.context.outputs.swift_corelibs_libdispatch_revision }}
swift_corelibs_xctest_revision: ${{ steps.context.outputs.swift_corelibs_xctest_revision }}
swift_crypto_revision: ${{ steps.context.outputs.swift_crypto_revision }}
swift_docc_render_artifact_revision: ${{ steps.context.outputs.swift_docc_render_artifact_revision }}
swift_docc_revision: ${{ steps.context.outputs.swift_docc_revision }}
swift_docc_symbolkit_revision: ${{ steps.context.outputs.swift_docc_symbolkit_revision }}
swift_driver_revision: ${{ steps.context.outputs.swift_driver_revision }}
swift_experimental_string_processing_revision: ${{ steps.context.outputs.swift_experimental_string_processing_revision }}
swift_format_revision: ${{ steps.context.outputs.swift_format_revision }}
Expand Down Expand Up @@ -608,6 +611,9 @@ jobs:
swift_corelibs_libdispatch_revision: ${{ needs.context.outputs.swift_corelibs_libdispatch_revision }}
swift_corelibs_xctest_revision: ${{ needs.context.outputs.swift_corelibs_xctest_revision }}
swift_crypto_revision: ${{ needs.context.outputs.swift_crypto_revision }}
swift_docc_render_artifact_revision: ${{ needs.context.outputs.swift_docc_render_artifact_revision }}
swift_docc_revision: ${{ needs.context.outputs.swift_docc_revision }}
swift_docc_symbolkit_revision: ${{ needs.context.outputs.swift_docc_symbolkit_revision }}
swift_driver_revision: ${{ needs.context.outputs.swift_driver_revision }}
swift_experimental_string_processing_revision: ${{ needs.context.outputs.swift_experimental_string_processing_revision }}
swift_format_revision: ${{ needs.context.outputs.swift_format_revision }}
Expand Down Expand Up @@ -695,6 +701,9 @@ jobs:
swift_corelibs_libdispatch_revision: ${{ needs.context.outputs.swift_corelibs_libdispatch_revision }}
swift_corelibs_xctest_revision: ${{ needs.context.outputs.swift_corelibs_xctest_revision }}
swift_crypto_revision: ${{ needs.context.outputs.swift_crypto_revision }}
swift_docc_render_artifact_revision: ${{ needs.context.outputs.swift_docc_render_artifact_revision }}
swift_docc_revision: ${{ needs.context.outputs.swift_docc_revision }}
swift_docc_symbolkit_revision: ${{ needs.context.outputs.swift_docc_symbolkit_revision }}
swift_driver_revision: ${{ needs.context.outputs.swift_driver_revision }}
swift_experimental_string_processing_revision: ${{ needs.context.outputs.swift_experimental_string_processing_revision }}
swift_format_revision: ${{ needs.context.outputs.swift_format_revision }}
Expand Down
96 changes: 96 additions & 0 deletions .github/workflows/swift-toolchain.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,18 @@ on:
required: true
type: string

swift_docc_render_artifact_revision:
required: true
type: string

swift_docc_revision:
required: true
type: string

swift_docc_symbolkit_revision:
required: true
type: string

swift_driver_revision:
required: true
type: string
Expand Down Expand Up @@ -3293,6 +3305,24 @@ jobs:
ref: ${{ inputs.swift_crypto_revision }}
path: ${{ github.workspace }}/SourceCache/swift-crypto
show-progress: false
- uses: actions/checkout@v4.2.2
with:
repository: swiftlang/swift-docc-render-artifact
ref: ${{ inputs.swift_docc_render_artifact_revision }}
path: ${{ github.workspace }}/SourceCache/swift-docc-render-artifact
show-progress: false
- uses: actions/checkout@v4.2.2
with:
repository: swiftlang/swift-docc
ref: ${{ inputs.swift_docc_revision }}
path: ${{ github.workspace }}/SourceCache/swift-docc
show-progress: false
- uses: actions/checkout@v4.2.2
with:
repository: swiftlang/swift-docc-symbolkit
ref: ${{ inputs.swift_docc_symbolkit_revision }}
path: ${{ github.workspace }}/SourceCache/swift-docc-symbolkit
show-progress: false
- uses: actions/checkout@v4.2.2
with:
repository: swiftlang/swift-driver
Expand Down Expand Up @@ -3898,6 +3928,62 @@ jobs:
- name: Build sourcekit-lsp
run: cmake --build ${{ github.workspace }}/BinaryCache/sourcekit-lsp

- name: Configure swift-docc-symbolkit
uses: ./SourceCache/ci-build/.github/actions/configure-cmake-project
with:
project-name: swift-docc-symbolkit
swift-version: ${{ inputs.swift_version }}
enable-caching: true
debug-info: ${{ inputs.debug_info }}
build-os: ${{ inputs.build_os }}
build-arch: ${{ inputs.build_arch }}
os: ${{ matrix.os }}
arch: ${{ matrix.arch }}
src-dir: ${{ github.workspace }}/SourceCache/swift-docc-symbolkit
bin-dir: ${{ github.workspace }}/BinaryCache/swift-docc-symbolkit
install-dir: ${{ github.workspace }}/BuildRoot/Library/Developer/Toolchains/${{ inputs.swift_version }}+Asserts/usr
swift-sdk-path: ${{ github.workspace }}/BinaryCache/Library/Developer/Platforms/${{ matrix.os }}.platform/Developer/SDKs/${{ matrix.os }}.sdk
built-compilers: '@("C", "Swift")'
cmake-defines: |
@{
'BUILD_SHARED_LIBS' = "NO";
'CMAKE_STATIC_LIBRARY_PREFIX_Swift' = "lib";
}
- name: Build swift-docc-symbolkit
run: cmake --build ${{ github.workspace }}/BinaryCache/swift-docc-symbolkit

- name: Configure swift-docc
uses: ./SourceCache/ci-build/.github/actions/configure-cmake-project
with:
project-name: swift-docc
swift-version: ${{ inputs.swift_version }}
enable-caching: true
debug-info: ${{ inputs.debug_info }}
build-os: ${{ inputs.build_os }}
build-arch: ${{ inputs.build_arch }}
os: ${{ matrix.os }}
arch: ${{ matrix.arch }}
src-dir: ${{ github.workspace }}/SourceCache/swift-docc
bin-dir: ${{ github.workspace }}/BinaryCache/swift-docc
install-dir: ${{ github.workspace }}/BuildRoot/Library/Developer/Toolchains/${{ inputs.swift_version }}+Asserts/usr
swift-sdk-path: ${{ github.workspace }}/BinaryCache/Library/Developer/Platforms/${{ matrix.os }}.platform/Developer/SDKs/${{ matrix.os }}.sdk
built-compilers: '@("C", "Swift")'
cmake-defines: |
@{
'BUILD_SHARED_LIBS' = "YES";
'CMAKE_STATIC_LIBRARY_PREFIX_Swift' = "lib";
'ArgumentParser_DIR' = "${{ github.workspace }}/BinaryCache/swift-argument-parser/cmake/modules";
'SwiftASN1_DIR' = "${{ github.workspace }}/BinaryCache/swift-asn1/cmake/modules";
'SwiftCrypto_DIR' = "${{ github.workspace }}/BinaryCache/swift-crypto/cmake/modules";
'SwiftMarkdown_DIR' = "${{ github.workspace }}/BinaryCache/swift-markdown/cmake/modules";
'LMDB_DIR' = "${{ github.workspace }}/BinaryCache/swift-lmdb/cmake/modules";
'IndexStoreDB_DIR' = "${{ github.workspace }}/BinaryCache/indexstore-db/cmake/modules";
'SymbolKit_DIR' = "${{ github.workspace }}/BinaryCache/swift-docc-symbolkit/cmake/modules";
'cmark-gfm_DIR' = "${{ github.workspace }}/BinaryCache/Library/cmark-gfm-${{ inputs.swift_cmark_version }}/usr/lib/cmake";
}
- name: Build swift-docc
run: cmake --build ${{ github.workspace }}/BinaryCache/swift-docc

- name: Install swift-argument-parser
run: cmake --build ${{ github.workspace }}/BinaryCache/swift-argument-parser --target install
- name: Install swift-collections
Expand All @@ -3922,6 +4008,8 @@ jobs:
run: cmake --build ${{ github.workspace }}/BinaryCache/sourcekit-lsp --target install
- name: Install swift-format
run: cmake --build ${{ github.workspace }}/BinaryCache/swift-format --target install
- name: Install swift-docc
run: cmake --build ${{ github.workspace }}/BinaryCache/swift-docc --target install

- uses: actions/upload-artifact@v4
with:
Expand Down Expand Up @@ -5413,6 +5501,13 @@ jobs:
with:
path: ${{ github.workspace }}/SourceCache/ci-build
show-progress: false
- uses: actions/checkout@v4.2.2
with:
repository: swiftlang/swift-docc-render-artifact
ref: ${{ inputs.swift_docc_render_artifact_revision }}
path: ${{ github.workspace }}/SourceCache/swift-docc-render-artifact
show-progress: false

- uses: ./SourceCache/ci-build/.github/actions/setup-build
with:
setup-vs-dev-env: true
Expand Down Expand Up @@ -5618,6 +5713,7 @@ jobs:
-p:SignOutput=${{ inputs.signed }} `
-p:CERTIFICATE=${env:CERTIFICATE} `
-p:PASSPHRASE=${{ secrets.PASSPHRASE }} `
-p:SWIFT_DOCC_RENDER_ARTIFACT_ROOT = "${{ github.workspace }}\SourceCache\swift-docc-render-artifact" `
Copy link

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MSBuild parameter assignment has spaces around the equals sign which will cause a syntax error. Should be -p:SWIFT_DOCC_RENDER_ARTIFACT_ROOT=\"${{ github.workspace }}\SourceCache\swift-docc-render-artifact\" without spaces around =.

Suggested change
-p:SWIFT_DOCC_RENDER_ARTIFACT_ROOT = "${{ github.workspace }}\SourceCache\swift-docc-render-artifact" `
-p:SWIFT_DOCC_RENDER_ARTIFACT_ROOT="${{ github.workspace }}\SourceCache\swift-docc-render-artifact" `

Copilot uses AI. Check for mistakes.
-p:SignToolPath=${env:SIGNTOOL_PATH} `
-p:AzureSignMetadata=${env:TRUSTED_SIGNING_METADATA_PATH} `
-p:AzureSignDlib=${env:TRUSTED_SIGNING_DLL_PATH} `
Expand Down