Skip to content

Add a new Dockerfile for building Swift-DocC-Render-Artifact #252

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

Conversation

ethan-kusters
Copy link
Contributor

Bug/issue #, if applicable: rdar://81634420

Summary

Adds a new Dockerfile that can be used to generate a built version of Swift-DocC-Render in isolation. This allows developers interested in having an up-to-date version of Swift-DocC-Render to build one in an automated way without installing Node.

Developers can build a copy of Swift-DocC-Render at the given branch with the included helper script by running something like the following:

./build-swift-docc-render.sh \
    --branch <branch-in-swift-docc-render-repo> \
    --output-path <path-to-output-directory>

The helper script starts by building a new version of the included Docker container with caching disabled. It then copies out the built artifact to the given output directory, and deletes the created Docker container.

Note: This PR has been opened after closing #251.

Adds a new Dockerfile that can be used to generate a built version of Swift-DocC-Render in isolation. This allows developers interested in having an up-to-date version of Swift-DocC-Render to build one in an automated way without installing Node.

Developers can build a copy of Swift-DocC-Render at the given branch with the included helper script by running something like the following:

    ./build-swift-docc-render.sh \
        --branch <branch-in-swift-docc-render-repo> \
        --output-path <path-to-output-directory>

The helper script starts by building a new version of the included Docker container with caching disabled. It then copies out the built artifact to the given output directory, and deletes the created Docker container.

Resolves r81634420.
@shahmishal
Copy link
Member

@swift-ci test

@shahmishal shahmishal merged commit 5df48ed into swiftlang:main Oct 19, 2021
@ethan-kusters ethan-kusters deleted the ekusters/r81634420-add-support-for-building-swift-docc-render-artifact branch October 20, 2021 00:29
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.

2 participants