Skip to content

Reformat pkgdown workflow #292

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

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Conversation

VisruthSK
Copy link
Collaborator

@VisruthSK VisruthSK commented Jun 13, 2025

  • Build site in master to .\docs
  • GitHub Action builds site on releases (double check to ensure Action doesn't wipe root and replace with static files)
  • Updated favicons

The repo's Pages settings will have to be updated to point towards the master branch and .\docs

Note that the site is built with Bootstrap 3 which has been deprecated for a while. Swapping to Bootstrap 5 would require some SCSS/CSS to maintain the exact theme, or a coordinated change of themes from all Stan pkgdown sites (probably through a template package). This PR doesn't attemp to further either goal, and sticks with the usual Bootstrap 3 and Cosmo from Bootswatch 3.

@VisruthSK VisruthSK changed the title Reformat packagedown workflow Reformat pkgdown workflow Jun 13, 2025
@codecov-commenter
Copy link

codecov-commenter commented Jun 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.54%. Comparing base (9886905) to head (7235e08).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #292   +/-   ##
=======================================
  Coverage   92.54%   92.54%           
=======================================
  Files          31       31           
  Lines        3018     3018           
=======================================
  Hits         2793     2793           
  Misses        225      225           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@VisruthSK
Copy link
Collaborator Author

On second though, if possible, it might make more sense to automatically build and deploy sites to https://dev.mc-stan.org/loo/ and setup another workflow to generate the site on releases which would get pushed to https://mc-stan.org/loo/.

@VisruthSK
Copy link
Collaborator Author

VisruthSK commented Jun 13, 2025

on:
pull_request:
should be removed once the workflow is confirmed to work.

Obviated

@jgabry
Copy link
Member

jgabry commented Jun 13, 2025

On second though, if possible, it might make more sense to automatically build and deploy sites to https://dev.mc-stan.org/loo/ and setup another workflow to generate the site on releases which would get pushed to https://mc-stan.org/loo/.

Yeah I agree that it would be preferable to only publish the site on https://mc-stan.org/loo/ when we do a release. If we publish at the main URL on every commit to master then the website could advertise unreleased features that aren't available on CRAN yet.

@jgabry
Copy link
Member

jgabry commented Jun 13, 2025

I think this looks good. But the regenerated website pages that are part of this PR are for the development version of loo, not the released version. So if I merge this won't it update the website to the development version?

@VisruthSK
Copy link
Collaborator Author

Right, I'll move files from the gh-pages branch into the docs folder then

@VisruthSK
Copy link
Collaborator Author

https://github.com/stan-dev/loo/actions/runs/15627201098/job/44023603976

Looks like the vignettes get built too.

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.

3 participants