Skip to content
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.

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

Add a custom build for swift-docc-render #1229

Merged
merged 6 commits into from
Dec 12, 2024

Conversation

matthewbastien
Copy link
Member

We need to build a special copy of swiftlang/swift-docc-render that will work in VS Code. However, this build does not need to happen every single time we build the extension. So, as a nice middle-ground I've opted to create a NPM script called update-swift-docc-render that will:

  1. clone swift-docc-render into a temporary directory
  2. apply our custom patches to swift-docc-render
  3. build a copy of swift-docc-render into assets/swift-docc-render

The asset will be checked into source control so that we don't have to build it unless swift-docc-render changes in the future.

@matthewbastien
Copy link
Member Author

It's also worth noting that building swift-docc-render requires node v18 which is a couple versions behind the version that VS Code uses.

@matthewbastien
Copy link
Member Author

Needed for #562

@award999
Copy link
Contributor

@swift-ci Please test

matthewbastien and others added 3 commits December 12, 2024 07:50
* Add "postinstall" script that runs the script to clone, patch, build
* When run as a post install script, do not build again if folder exists
@matthewbastien matthewbastien merged commit 25ee843 into swiftlang:main Dec 12, 2024
15 checks passed
@matthewbastien matthewbastien deleted the swift-docc-render branch December 12, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants