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.

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

Add a workflow to test some external book example #1409

Open
1 task
cderv opened this issue Feb 28, 2023 · 2 comments
Open
1 task

Add a workflow to test some external book example #1409

cderv opened this issue Feb 28, 2023 · 2 comments

Comments

@cderv
Copy link
Collaborator

cderv commented Feb 28, 2023

We could maybe add a workflow to run from time to time to build known project out there and checks that everything is still at least building ok.

Hard part is testing that the content is not changed has this would imply manual inspection.
For this, maybe it is best to rely on each developer to tests against dev bookdown regularly. we could laybe write about that if we want to promote.

Several examples:
@ThierryO
Copy link
Contributor

Here is an idea of a potential workflow which assumes that changing to the dev version should not alter the output. Not sure if it works for all output formats.

  1. build the examples using the production version of bookdown
  2. place the output under version control
  3. rebuild the examples using the dev version of bookdown while keeping everything else the same.
  4. use the version control to see what changed

@cderv
Copy link
Collaborator Author

cderv commented Feb 28, 2023

This is a good idea. We do such type of comparing in knitr-examples repo but for single document.

This would require that nothing is using timestamp or non seed set randomization. I am thinking about what will be in HTML <head> for example, or any random id like for htmlwidgets. But this definitely worth a try for HTML output.

For PDF, it is a bit harder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ThierryO @cderv