Skip to content

Install pkgdown before pkgdown::build_site() - #4

Merged
lwaldron merged 2 commits into
develfrom
install-pkgdown
Oct 3, 2026
Merged

lwaldron merged 2 commits into
develfrom
install-pkgdown

Conversation

@lwaldron

@lwaldron lwaldron commented Oct 3, 2026

Copy link
Copy Markdown
Member

The dependency setup installs remotes/rcmdcheck/BiocCheck/covr plus each calling package's declared dependencies, but nothing installs pkgdown itself, so the Build pkgdown step (release-branch pushes with enable_pkgdown, the default) fails unless the calling package happens to list pkgdown in Suggests — which none of the curated*Data packages do, and adding it there risks "suggested but not available" notes on the Bioconductor builders. Install it just before use instead.

Flagged by Copilot review on waldronlab/curatedCRCData#5.

🤖 Generated with Claude Code

The reusable workflow installs remotes/rcmdcheck/BiocCheck/covr plus
the package's declared dependencies, but nothing installs pkgdown, so
the Build pkgdown step (release-branch pushes with enable_pkgdown)
fails unless a calling package happens to Suggest it. Install it just
before use. Flagged by Copilot review on waldronlab/curatedCRCData#5.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟡 Changes recommended

The installation does not honor the workflow’s configured CRAN repository.

Review effort: Balanced
Findings: 1 Medium severity

Open (1)
What changed in this PR

Installs pkgdown before building package documentation.

Changes:

  • Adds conditional pkgdown installation before build_site().
File Description
.github/​workflows/​bioc-pr-cmdcheck-pkgdown.yml Installs pkgdown before site generation.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/bioc-pr-cmdcheck-pkgdown.yml Outdated
Set options(repos) from the CRAN env var before BiocManager::install,
matching the workflow's other install steps. Flagged by Copilot.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@lwaldron

lwaldron commented Oct 3, 2026

Copy link
Copy Markdown
Member Author

Good catch — now sets options(repos) from the CRAN env var before installing, matching the other install steps.

🤖 Drafted with Claude Code

@lwaldron
lwaldron merged commit ee4a7f4 into devel Oct 3, 2026
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