Skip to content

[BuildScript] Add products for Swift-DocC and Swift-DocC-Render #39723

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

Jump to bottom
Merged
merged 3 commits into from
Nov 2, 2021
Merged

[BuildScript] Add products for Swift-DocC and Swift-DocC-Render #39723

merged 3 commits into from
Nov 2, 2021

Conversation

d-ronnqvist
Copy link
Contributor

This adds build script products for Swift-DocC and Swift-DocC-Render so that these projects can be built as part of a Swift toolchain.

This adds two new flags to ./utils/build-script (--swiftdocc and --swiftdoccrender) and updates the buildbot_linux preset and the mixin_osx_package_base preset to build Swift-DocC but not Swift-DocC-Render.

Instead, when only --swiftdocc is passed, the Swift-DocC product will copy the already built swift-docc-render template included in the host toolchain (when present) over to the install toolchain. If the host toolchain doesn't include a swift-docc-render template, the Swift-DocC product will raise a warning.

This allows developers to build Swift-DocC from source as part of a toolchain without needing to build Swift-DocC-Render from source (assuming that they haven't made any changes to the Swift-DocC-Render source code).

For developers who want to build a toolchain with both Swift-DocC and Swift-DocC-Render built from source, there are new presets that also include the --swiftdoccrender flag. There's also a new --swift-docc-render flag added to ./utils/build-toolchain which selects a preset that build Swift-DocC-Render.

Resolves rdar://79703353

@QuietMisdreavus
Copy link
Contributor

@swift-ci Please test

@QuietMisdreavus
Copy link
Contributor

@swift-ci Please build toolchain

@shahmishal
Copy link
Member

swiftlang/swift-integration-tests#93
@swift-ci build toolchain

@swift-ci
Copy link
Contributor

Build failed
Swift Test Linux Platform
Git Sha - f662d50

@swift-ci
Copy link
Contributor

Build failed
Swift Test OS X Platform
Git Sha - f662d50

@shahmishal
Copy link
Member

@swift-ci Please test macOS

@swift-ci
Copy link
Contributor

Build failed
Swift Test OS X Platform
Git Sha - f662d50

@ethan-kusters ethan-kusters mentioned this pull request Oct 14, 2021
Closed
@shahmishal
Copy link
Member

@swift-ci test

@shahmishal
Copy link
Member

swiftlang/swift-integration-tests#93
@swift-ci build toolchain

@swift-ci
Copy link
Contributor

Build failed
Swift Test OS X Platform
Git Sha - 6fff54d

@swift-ci
Copy link
Contributor

Build failed
Swift Test Linux Platform
Git Sha - 6fff54d

@ethan-kusters ethan-kusters mentioned this pull request Oct 20, 2021
Merged
3 tasks
@shahmishal
Copy link
Member

swiftlang/swift-integration-tests#93
@swift-ci build toolchain

@shahmishal
Copy link
Member

@swift-ci test

@swift-ci
Copy link
Contributor

Build failed
Swift Test Linux Platform
Git Sha - 6fff54d

@swift-ci
Copy link
Contributor

Build failed
Swift Test OS X Platform
Git Sha - 6fff54d

@shahmishal
Copy link
Member

swiftlang/swift-integration-tests#93
@swift-ci build toolchain

@swift-ci
Copy link
Contributor

Linux Toolchain (Ubuntu 16.04)
Download Toolchain
Git Sha - 6fff54d

Install command
tar zxf swift-PR-39723-717-ubuntu16.04.tar.gz
More info

@d-ronnqvist
Copy link
Contributor Author

@swift-ci test

@swift-ci
Copy link
Contributor

Build failed
Swift Test Linux Platform
Git Sha - 6fff54d

@swift-ci
Copy link
Contributor

Build failed
Swift Test OS X Platform
Git Sha - 6fff54d

@ethan-kusters
Add get_dependencies method to Swift-DocC-Render script
4d73833 
Adding the required `get_dependencies` class method should resolve the remaining test failures we're seeing for macOS toolchain builds.
@ethan-kusters
Copy link
Contributor

swiftlang/swift-integration-tests#93
@swift-ci build toolchain

@ethan-kusters
Copy link
Contributor

@swift-ci test

@swift-ci
Copy link
Contributor

Build failed
Swift Test Linux Platform
Git Sha - 4d73833

@ethan-kusters
Copy link
Contributor

@swift-ci Please test Linux platform

@swift-ci
Copy link
Contributor

Linux Toolchain (Ubuntu 16.04)
Download Toolchain
Git Sha - 4d73833

Install command
tar zxf swift-PR-39723-720-ubuntu16.04.tar.gz
More info

@swift-ci
Copy link
Contributor

macOS Toolchain
Download Toolchain
Git Sha - 4d73833

Install command
tar -zxf swift-PR-39723-1204-osx.tar.gz --directory ~/

@franklinsch franklinsch merged commit 0a04cce into swiftlang:main Nov 2, 2021
@franklinsch franklinsch mentioned this pull request Nov 2, 2021
Merged
@Kyle-Ye Kyle-Ye mentioned this pull request Nov 3, 2021
Merged
etcwilde added a commit to etcwilde/swift that referenced this pull request Nov 3, 2021
@etcwilde
Revert "Merge pull request swiftlang#39723 from d-ronnqvist/add-docc-…
7f1148c 
…in-build-script"

This reverts commit 0a04cce, reversing
changes made to 2ad0eb7.
@Kyle-Ye Kyle-Ye mentioned this pull request Dec 11, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shahmishal shahmishal shahmishal approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@d-ronnqvist @QuietMisdreavus @shahmishal @swift-ci @ethan-kusters @franklinsch