Skip to content

Auto-generate VISCtemplates website with pkgdown/GH actions - #323

Open
slager wants to merge 3 commits into
developfrom
setup_pkgdown
Open

slager wants to merge 3 commits into
developfrom
setup_pkgdown

Conversation

@slager

@slager slager commented Dec 4, 2025

Copy link
Copy Markdown
Contributor

Description

Draft PR for auto-generated VISCtemplates website. You can preview the built site locally from this branch with pkgdown::build_site().

Related Issues

#313
FredHutch/VISCfunctions#119

Checklist

  • This PR includes unit tests
  • This PR establishes a new function or updates parameters in an existing function
    • The roxygen skeleton for this function has been updated using devtools::document
  • I have updated NEWS.md to describe the proposed changes

@codecov

codecov Bot commented Dec 4, 2025 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.41%. Comparing base (d0f23c7) to head (6c866ca).
⚠️ Report is 169 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #323   +/-   ##
========================================
  Coverage    85.41%   85.41%           
========================================
  Files           10       10           
  Lines          377      377           
========================================
  Hits           322      322           
  Misses          55       55           

☔ View full report in Codecov by Harness.
📢 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.

@kelliemac

Copy link
Copy Markdown
Contributor

note: waiting on progress on #337 before merging this to develop

@slager
slager marked this pull request as ready for review October 14, 2026 19:40
@kelliemac
kelliemac self-requested a review October 14, 2026 20:55
Comment thread _pkgdown.yml
template:
bootstrap: 5

reference:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@slager I added this section to group the package functions by type on the pkgdown site. I don't feel too strongly about the exact grouping, just that it's really helpful to group in some fashion like this - so if you have other ideas of how to do this feel free to revise!

Comment thread DESCRIPTION
family = "Slager",
role = c("aut"),
email = "dslager@fredhutch.org")
person(given = "Kellie",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

For some reason, when I build the site locally, I only see my name show up under developers. Not sure if that is just on my end - can you check? We should definitely have everyone's names here showing up on the site. Also, not sure if it's really accurate to have me listed as the maintainer, but I won't object too much if there isn't a natural other choice. @mayerbry do you have any thoughts about this?

@kelliemac kelliemac left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I added a tweak to the site formatting (see changes I pushed) that I think is nice to bake in now - no conflict with what was already there, just an add-on.

Also see comment about whether the list of developers is rendering properly on the site - on my end I only see my name, but I'm not sure if that's how it looks to everyone. @slager can you please check and fix if needed?

Overall looks great, excited to push this through!

@kelliemac

Copy link
Copy Markdown
Contributor

uh-oh now the tests are failing :( but it doesn't seem related to my recent code changes as fair as I can tell...

@kelliemac

kelliemac commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

fix for the underlying issue(s) in the CI is here: #364

let's merge that PR into develop, then port the changes over here to confirm that it resolves the CI issues.

This branch has not been deployed

No deployments
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.

2 participants