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

implement automatic recompilation of the vignettes #50

Closed
matteodelucchi opened this issue Apr 4, 2024 · 4 comments · Fixed by #137
Closed

implement automatic recompilation of the vignettes #50

matteodelucchi opened this issue Apr 4, 2024 · 4 comments · Fixed by #137
Assignees
@matteodelucchi
Labels
documentation Improvements or additions to documentation

Comments

@matteodelucchi
Copy link
Contributor

matteodelucchi commented Apr 4, 2024 •
edited
Loading

Think about how to incorporate this in the pipeline.
@matteodelucchi matteodelucchi self-assigned this Apr 4, 2024
@matteodelucchi matteodelucchi added the documentation Improvements or additions to documentation label Apr 4, 2024
@matteodelucchi
Copy link
Contributor Author

Only run the examples (redo the simulations) on a major version bump.

On minor version bumps make it optional to run the simulation (i.e. manual trigger of the action)

handle this in dedicated action yaml

Keep the output in an artifact for later use in the documentation

@j-i-l
Copy link
Collaborator

j-i-l commented May 1, 2024

this belongs to #81

@j-i-l j-i-l mentioned this issue May 1, 2024
Merged
26 tasks
@matteodelucchi matteodelucchi changed the title decide on when to recompile the vignettes implement automatic recompilation of the vignettes May 8, 2024
@matteodelucchi
Copy link
Contributor Author

Process: .Rmd.orig -- calc --> .Rmd -- render --> .html
render is performed by pkgdown, testthat and CRAN checks.
calc is performed by precompile.R.

To be implemented:
Workflow that is triggered on the label that sources precompile.R. Then, the .Rmd files should be committed to the current branch (this is a dev-branch or the release branch when the "release" workflow sets the label).

matteodelucchi added a commit that referenced this issue Jul 18, 2024
@matteodelucchi
attempt to rebuild vignettes on label. Addresses #50
a3f22f5
@matteodelucchi matteodelucchi mentioned this issue Jul 18, 2024
Merged
@matteodelucchi matteodelucchi linked a pull request Jul 18, 2024 that will close this issue
attempt to rebuild vignettes on label #137
Merged
@matteodelucchi
Copy link
Contributor Author

consider to use the abn container to avoid installing arbitrary package versions.

@matteodelucchi matteodelucchi mentioned this issue Jul 25, 2024
Closed
matteodelucchi added a commit that referenced this issue Jul 28, 2024
@matteodelucchi
attempt to rebuild vignettes on label (#137)
4279bc3 
* attempt to rebuild vignettes on label. Addresses #50

* renamed the label

* use abn containers as basis.

* fixed env was defined twice.

* push to current branch

* changed branch name to github branch name.

* using repo scope token

* changed git user to abn-cicd-helper bot

* try commit and push with GH action...

* try again with the push action

* Revert "changed git user to abn-cicd-helper bot"

This reverts commit a1396d7.

* added directory as safe to fix dubious ownership warning.

* removed push origin

* use gh cli to checkout PR

* in container gh must be installed. On standart runners it would be by default.

* add specific sysreqs for INLA installation

* added github token to env

* add safe directory before checkout of PR

* Automated Vignette Compilation

* fix mess

* commit only recompiled vignettes but nothing else

* commit only recompiled vignettes but nothing else

* fixed divergent histories

* need to install abn package with the newest r-containers!

* Automated Vignette Compilation

* commit everything within vignettes directory

* debugging git add

* fix image location

* typo

* debugging adding png

* typo

* Automated Vignette Compilation

* place plots in the correct folder

* removed wrongly placed figures

* Automated Vignette Compilation

* move them, not copy!

* Automated Vignette Compilation

* updated interpretation of benchmark plot

---------

Co-authored-by: GitHub Vignette Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matteodelucchi matteodelucchi

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

attempt to rebuild vignettes on label furrer-lab/abn
2 participants
@j-i-l @matteodelucchi