Skip to content

Replace clone-swift.sh with git submodule for Swift headers #217

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

Merged
Kyle-Ye merged 3 commits into from
Feb 25, 2026
Merged

Replace clone-swift.sh with git submodule for Swift headers #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77e230f
Add submodule
Kyle-Ye Feb 25, 2026
d6eaa6f
Update submodules config in workflows
Kyle-Ye Feb 25, 2026
06cd691
Remove clone-swift.sh and CloneSwiftPlugin in favor of submodule
Kyle-Ye Feb 25, 2026
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
29 changes: 0 additions & 29 deletions .github/actions/checkout-swift-headers/action.yml
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/compatibility_tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ jobs:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Setup Xcode
uses: OpenSwiftUIProject/OpenSwiftUI/.github/actions/setup-xcode@main
with:
xcode-version: ${{ matrix.xcode-version }}
- name: Set up build environment
run: Scripts/CI/darwin_setup_build.sh
shell: bash
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
- name: Run tests against Apple's AttributeGraph on macOS via SwiftPM
run: |
swift test \
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/compute.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ jobs:
container: swift:${{ matrix.swift_version }}-jammy
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Set up Linux build environment
run: Scripts/CI/linux_compute_build.sh
shell: bash
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
- name: Build in debug mode
run: swift build -c debug -Xcc -Wno-elaborated-enum-base

Expand All @@ -44,12 +44,12 @@ jobs:
OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY: 1
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Setup Xcode
uses: OpenSwiftUIProject/OpenSwiftUI/.github/actions/setup-xcode@main
with:
xcode-version: ${{ matrix.xcode-version }}
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
- name: Build in debug mode
run: swift build -c debug

Expand All @@ -71,12 +71,12 @@ jobs:
OPENATTRIBUTEGRAPH_OPENATTRIBUTESHIMS_COMPUTE_USE_BINARY: 1
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Setup Xcode
uses: OpenSwiftUIProject/OpenSwiftUI/.github/actions/setup-xcode@main
with:
xcode-version: ${{ matrix.xcode-version }}
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
- name: Build in debug mode on iOS Simulator
run: |
xcodebuild build \
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ios.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ jobs:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Setup Xcode
uses: OpenSwiftUIProject/OpenSwiftUI/.github/actions/setup-xcode@main
with:
xcode-version: ${{ matrix.xcode-version }}
- name: Set up build environment
run: Scripts/CI/darwin_setup_build.sh
shell: bash
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
- name: Build in debug mode on iOS
run: |
xcodebuild build \
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/macos.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ jobs:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Setup Xcode
uses: OpenSwiftUIProject/OpenSwiftUI/.github/actions/setup-xcode@main
with:
xcode-version: ${{ matrix.xcode-version }}
- name: Set up build environment
run: Scripts/CI/darwin_setup_build.sh
shell: bash
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
- name: Build and run tests in debug mode with coverage
run: |
swift test \
Expand Down
3 changes: 1 addition & 2 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,11 @@ jobs:
- uses: actions/checkout@v4
with:
fetch-depth: 0
submodules: true
- name: Setup Xcode
uses: OpenSwiftUIProject/OpenSwiftUI/.github/actions/setup-xcode@main
with:
xcode-version: "16.4"
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
- name: Build XCFramework
run: ./Scripts/build_xcframework.sh
- name: Compute Checksum
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ubuntu.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ jobs:
container: swift:${{ matrix.swift_version }}-jammy
steps:
- uses: actions/checkout@v4
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
with:
submodules: true
- name: Building and running tests in debug mode with coverage
run: |
swift test \
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/xcframework.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ jobs:
GH_TOKEN: ${{ github.token }}
steps:
- uses: actions/checkout@v4
with:
submodules: true
- name: Setup Xcode
uses: OpenSwiftUIProject/OpenSwiftUI/.github/actions/setup-xcode@main
with:
xcode-version: ${{ matrix.xcode-version }}
- name: Checkout Swift headers
uses: ./.github/actions/checkout-swift-headers
- name: Build XCFramework
run: ./Scripts/build_xcframework.sh
- name: Upload XCFramework
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ DerivedData/
.netrc
coverage.txt
TODO.md
Checkouts/
Checkouts/*
!Checkouts/swift
.ag_template/
build/
.ag_repo/
Expand Down
4 changes: 4 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[submodule "Checkouts/swift"]
path = Checkouts/swift
url = https://github.com/OpenSwiftUIProject/swift-runtime-headers.git
branch = release/6.1
1 change: 1 addition & 0 deletions Checkouts/swift
Open in desktop
Submodule swift added at 358e0e
2 changes: 1 addition & 1 deletion Package.resolved
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 1 addition & 9 deletions Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,13 +266,6 @@ extension [SwiftSetting] {
}
}

// MARK: - Plugin

let swiftClonePlugin = Target.plugin(
name: "CloneSwiftPlugin",
capability: .buildTool()
)

// MARK: - Targets

let platformTarget = Target.target(
Expand Down Expand Up @@ -304,7 +297,7 @@ let openAttributeGraphCxxTarget = Target.target(
linkerSettings: [
.linkedLibrary("z"),
],
plugins: [.plugin(name: swiftClonePlugin.name)]
plugins: []
)
let openAttributeGraphTarget = Target.target(
name: "OpenAttributeGraph",
Expand Down Expand Up @@ -447,7 +440,6 @@ if computeCondition {
package.targets.append(target)
} else {
package.targets.append(contentsOf: [
swiftClonePlugin,
platformTarget,
utilitiesTarget,
openAttributeGraphTarget,
Expand Down
33 changes: 0 additions & 33 deletions Plugins/CloneSwiftPlugin/plugin.swift
View file
Open in desktop

This file was deleted.

8 changes: 2 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,10 @@ The current suggested toolchain to build the project is Swift 6.1.2 / Xcode 16.4

### Clone Swift headers

The project requires Swift toolchain headers for compilation. You can either clone them manually or let the build plugin handle it:
The project requires Swift toolchain headers for compilation. They are included as a git submodule:

```shell
# Option 1: Clone headers manually
./Scripts/clone-swift.sh

# Option 2: Let the build plugin clone headers (requires --disable-sandbox)
swift build --disable-sandbox
git submodule update --init
```
Copy link

@augmentcode augmentcode bot Feb 25, 2026

Choose a reason for hiding this comment

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

Consider documenting git submodule update --init --recursive (and/or git clone --recurse-submodules) here so nested submodules won’t be missed if they’re introduced later.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.


## License
Expand Down
100 changes: 0 additions & 100 deletions Scripts/clone-swift.sh
View file
Open in desktop

This file was deleted.