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

Explore possibilities for linking the executed (with output) and rendered (HTML) notebooks in a PR #532

Open
adrn opened this issue Jan 18, 2022 · 4 comments

Comments

@adrn
Copy link
Member

adrn commented Jan 18, 2022

The build artifacts from a PR's CI run should contain these things. Is there a resource we can use that will take the artifact, unzip it, and serve it at a url?

@adrn
Copy link
Member Author

adrn commented Jan 18, 2022

@Cadair: We used to use Giles to provide a link to our built Sphinx site in a PR. We've switched to using nbconvert more directly, but it would be cool to link to the converted/rendered HTML notebooks in a PR. Do you know of relevant infrastructure we could use to do that?

@Cadair
Copy link
Member

Cadair commented Jan 24, 2022

Well if you use circleci and upload the html from nbconvert to circleci's artifacts then you could still use giles as you can configure it to link to any file on circleci's aritfacts.

I am not aware of any other CI provider other than circle CI which lets you direct link to HTML pages and be able to see them in the browser without any issues, so that's why I say use circleci.

@jonathansick
Copy link
Contributor

Maybe we could set up a staging server? Deploy into this repo's GitHub Pages with a directory prefixed by the PR number? We could even have a GitHub Actions workflow that cleans up the staged directory in gh-pages when a PR is closed.

There is the security concern of hosting content from PRs (though it wouldn't be highly visible and wouldn't be indexed by search engines, so it may be an acceptable risk)

@Cadair
Copy link
Member

Cadair commented Apr 14, 2022

You could but given that circle ci provides that feature for free why would you?

@eteq eteq mentioned this issue Apr 14, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants