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

[Suggestion]: Add Github action to build book #9

Open
Aeilert opened this issue Aug 20, 2021 · 3 comments
Open

[Suggestion]: Add Github action to build book #9

Aeilert opened this issue Aug 20, 2021 · 3 comments
Assignees

Comments

@Aeilert
Copy link

Aeilert commented Aug 20, 2021

Hi Andres,

Since this is relatively live document with many contributors I was thinking we could add a Github action to always build from the latest .Rmd files when merging to master. So that we don't need to worry about adding all those extra files ourselves.

It possible that we need to host the site in a separate gh-pages branch though. See

https://bookdown.org/yihui/bookdown/github.html

In order to add an empty gh-pages branch on remote do:

git checkout --orphan gh-pages
git rm -rf .
git commit --allow-empty -m "root commit"
git push origin gh-pages
@randrescastaneda
Copy link
Member

Hi @Aeilert ,

I think this is a good idea. A few comments.

  1. Since it is being deployed in /docs and master, I think Git will keep tracking everything that goes in /docs, so we would have to render locally in /_book or somewhere else so it is not capture by git, right?
  2. Most of the sides that I have found are to deploy in Netlify, not github pages (like this). Yet, I found this other to deploy in gh-pages, but it does not seem so trivial, does it?

If you want, please give it a try and see if it works. For now, I am going to deploy the most recent version including your contributions.

Thanks

@randrescastaneda
Copy link
Member

randrescastaneda commented Aug 24, 2021

Also, I think we could make use of this and this, right?

@Aeilert
Copy link
Author

Aeilert commented Aug 24, 2021

Hi @randrescastaneda,

Sounds good. I'll take a look. Deploying with GH actions for pkgdown works quite well, but I haven't tried it with bookdown.

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

No branches or pull requests

2 participants