Setup PR Preview workflow#175
Conversation
|
Nice! This would close #68. I also don't have access to repo secrets I think @dcherian or @andersy005 would need to add |
|
@andersy005 can you take a look please? |
Co-authored-by: Anderson Banihirwe <[email protected]>
|
This is ready to go now. Seems like the PR comments only works for non-forked PRs. This is due to the fact that Github has restricted PR permission to read-only for forked PRs. See https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token |
|
To access the URL to the preview, maintainers can go to the workflow summary. For example: https://github.com/xarray-contrib/xarray-tutorial/actions/runs/5260269206 |
|
Quick Q: What's the reason for preferring this workflow over the RTD workflow? |
I've helped out with a curriculum book using RTD here https://github.com/UW-GDA/jupyterbook. The PR previews and versioning is definitely nice, but the main drawback in my mind is navigating over to a separate web interface for exploring logs when things go wrong. Also building via github actions gives more flexibility (and perhaps more resources?) but that is not such a big deal if the notebooks remain small |
|
My concern is the extra (unfamiliar) maintenance overhead, but we can evaluate later. |
* upstream/main: move custom accessors to advanced and add more complex, runnable examples (xarray-contrib#168) Update and reorganize apply_ufunc material (xarray-contrib#180) Add jupyterlab-myst 2.0 and sphinx-exercise (xarray-contrib#187) Add jupyterlab-myst (xarray-contrib#182) Add codespace config for scipy 2023 (xarray-contrib#184) Add SciPy Instructions (xarray-contrib#183) Edits to "Xarray and Dask" (xarray-contrib#177) Setup PR Preview workflow (xarray-contrib#175) contents write permissions for github token (xarray-contrib#178)
4 participants
Overview
This PR uses https://surge.sh/ for PR preview. Currently this will not work as I don't have enough permission to add
SURGE_TOKENinto secrets. Someone needs to create the token and set it. Please see instructions there: https://surge.sh/help/integrating-with-travis-ci