Skip to content

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

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

Closed
bitjammer opened this issue Jul 26, 2022 · 6 comments · Fixed by #25
Closed

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

bitjammer opened this issue Jul 26, 2022 · 6 comments · Fixed by #25
Labels
enhancement New feature or request good first issue Good for newcomers improvement

Comments

@bitjammer
Copy link
Contributor

From #21 (comment)

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:

  • Don't set the following:
    • SWIFT_DOCC_ROOT
    • SWIFT_DOCC_RENDER_ARTIFACT_ROOT
    • SWIFT_DOCC_BRANCH
    • SWIFT_DOCC_RENDER_ARTIFACT_BRANCH
  • Don't clone swift-docc or swift-docc-render-artifact
  • Also don't set:
    • DOCC_EXEC
    • DOCC_HTML_DIR

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

@A-N-uraag
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor

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

@A-N-uraag
Copy link
Contributor

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

@bitjammer
Copy link
Contributor Author

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

@bitjammer
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers improvement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants