Skip to content

Conversation

@AR21SM
Copy link
Member

@AR21SM AR21SM commented Jun 19, 2025

This PR adds a GitHub Action that builds and deploys a preview of the book for each pull request.

The preview is automatically generated and hosted under gh-pages/pr-preview/ so changes can be reviewed live before merging.

Fixes #80.

@AR21SM
Copy link
Member Author

AR21SM commented Jun 19, 2025

Hi @aterrel, Could you please review this PR? Now I think the preview bot is working fine.

@AR21SM
Copy link
Member Author

AR21SM commented Jun 19, 2025

@aterrel!
Could you please enable read and write permissions for GitHub Actions in the repo settings? You can do this from:
Settings → Actions → General → Workflow permissions → Allow read and write permissions
image

ad-m/github-push-action#96

i think once that's enabled, the bot will deploy the PR preview successfully. Thank you! :)

@AR21SM AR21SM force-pushed the Fix-preview.yml branch 2 times, most recently from dafc014 to 3ccd25e Compare June 19, 2025 16:32
Copy link
Contributor

@OriolAbril OriolAbril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

- name: Install dependencies
run: |
pip install jupyter-book
pip install sphinx-tags
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also update this to use pip install -r requirements.txt so it matches the workflow on the readme (and would make the preview robust to changes in the requirements)

@aterrel aterrel merged commit b106fc6 into numfocus:main Jun 24, 2025
1 check failed
@AR21SM AR21SM deleted the Fix-preview.yml branch June 24, 2025 12:06
@AR21SM AR21SM restored the Fix-preview.yml branch June 24, 2025 12:06
@AR21SM AR21SM deleted the Fix-preview.yml branch June 28, 2025 06:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix preview github action runner

3 participants