swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC
https://swiftpackageindex.com/swiftlang/swift-docc-plugin/documentation/swiftdoccplugin
Apache License 2.0
322 stars 53 forks source link

[`./bin/test`] Allow skipping clone of `swift-docc` and `swift-docc-render-artifact` #22

Closed bitjammer closed 2 years ago

bitjammer commented 2 years ago

From https://github.com/apple/swift-docc-plugin/pull/21#discussion_r929419898

In some scenarios, running swift-docc-plugin tests against the built-in docc in the installed toolchain could save time. Add an option to ./bin/test to skip cloning swift-docc and swift-docc-render-artifact and setting the environment variables to use those.

Behavior:

If --skip-building-upstream-docc (or perhaps an environment variable) is set:

See the above mentioned pull request for new code that should be skipped in this case.

A-N-uraag commented 2 years ago

Hi @bitjammer, can I work on this? I went through the mentioned PR and I now have a clear idea on what needs to be done.

bitjammer commented 2 years ago

Of course, that’s why it’s here! Thank you for taking it on. Please have a go and let me know if you have any questions.

A-N-uraag commented 2 years ago

Hi @bitjammer, I raised a PR. I used the approach to use an env variable. Hope that's fine.

A-N-uraag commented 2 years ago

Hi @bitjammer, just sending a little nudge to bump up the PR in your inbox. Thanks.

bitjammer commented 2 years ago

Thank you! I will have a look at this today.

bitjammer commented 2 years ago

Nice work @A-N-uraag, thank you.