Skip to content

Setup PR Preview workflow #175

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
Jun 14, 2023
Merged

Setup PR Preview workflow #175

merged 11 commits into from
Jun 14, 2023

Conversation

lsetiawan
Copy link
Member

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_TOKEN into secrets. Someone needs to create the token and set it. Please see instructions there: https://surge.sh/help/integrating-with-travis-ci

@scottyhq
Copy link
Contributor

scottyhq commented Jun 3, 2023

Nice! This would close #68. I also don't have access to repo secrets I think @dcherian or @andersy005 would need to add SURGE_TOKEN

@dcherian dcherian requested a review from andersy005 June 5, 2023 23:55
@dcherian
Copy link
Contributor

@andersy005 can you take a look please?

@lsetiawan lsetiawan requested a review from scottyhq June 13, 2023 20:55
@lsetiawan
Copy link
Member Author

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

@lsetiawan
Copy link
Member Author

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

@dcherian
Copy link
Contributor

Quick Q: What's the reason for preferring this workflow over the RTD workflow?

@scottyhq
Copy link
Contributor

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

@dcherian
Copy link
Contributor

My concern is the extra (unfamiliar) maintenance overhead, but we can evaluate later.

@dcherian dcherian merged commit b81bca6 into xarray-contrib:main Jun 14, 2023
@dcherian dcherian mentioned this pull request Jun 14, 2023
Closed
@lsetiawan lsetiawan deleted the add_previews branch June 15, 2023 23:10
@andersy005 andersy005 mentioned this pull request Jun 16, 2023
Closed
dcherian added a commit to dcherian/xarray-tutorial that referenced this pull request Jul 3, 2023
@dcherian
Merge remote-tracking branch 'upstream/main' into sidebar-update
22c0249 
* 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andersy005 andersy005 andersy005 left review comments

@scottyhq scottyhq Awaiting requested review from scottyhq

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@lsetiawan @scottyhq @dcherian @andersy005