ci: add GitHub Actions workflow and .Rbuildignore - #120
Conversation
There was a problem hiding this comment.
Pull request overview
Adds CI automation for the package via a GitHub Actions workflow that reuses the waldronlab Bioconductor CMD check + pkgdown workflow, and ensures the .github/ directory is excluded from R package builds.
Changes:
- Add
.github/workflows/ci.ymlto run PR CMD check and (on selected pushes) build the pkgdown site via a reusable workflow. - Add
.github/to.Rbuildignoreso it is not included in the R build tarball.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.Rbuildignore |
Ignores the .github/ directory during R CMD build. |
.github/workflows/ci.yml |
Introduces a reusable-workflow-based CI job for PR checks and branch push events. |
Comments suppressed due to low confidence (3)
.github/workflows/ci.yml:8
- The
pathsglob**.ymldoes not reliably match.ymlfiles in subdirectories (e.g..github/workflows/ci.yml), so pushes that change this workflow may not trigger CI. Use**/*.yml(and optionally**/*.yaml) to match nested workflow files.
paths:
- 'DESCRIPTION'
- '**.yml'
.github/workflows/ci.yml:15
- The reusable workflow is referenced by a mutable branch (
@devel). For supply-chain security and reproducibility, pinuses:to a tag or full commit SHA fromwaldronlab/.githubinstead of a branch name.
uses: waldronlab/.github/.github/workflows/bioc-pr-cmdcheck-pkgdown.yml@devel
.github/workflows/ci.yml:20
- This workflow requests write permissions (
contents/pages/id-token) and inherits all secrets for the called workflow. Consider scoping permissions/secrets to the minimum required (especially forpull_requestruns) to reduce blast radius if untrusted code executes.
secrets: inherit
permissions:
contents: write
pages: write
id-token: write
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| push: | ||
| paths: | ||
| - 'DESCRIPTION' | ||
| - '**.yml' | ||
| branches: | ||
| - devel | ||
| - 'RELEASE_*' |
39a9efd to
bac8bd8
Compare
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
.Rbuildignore:1
.Rbuildignoreentries are regular expressions. Using.github/is unanchored and the leading.is a regex wildcard, which can unintentionally match other paths. Prefer an anchored, escaped pattern for the.githubdirectory.
^\.github$
vjcitn
left a comment
There was a problem hiding this comment.
I am fine with these changes. Longer term we should arrange two signoffs from core.
|
Merging, hoping version was bumped. |
|
No version bump because there was no change to the built .tar.gz package. |
Adds
.github/workflows/ci.ymlusing the reusable Bioconductor BiocCheck workflow (https://github.com/Bioconductor/workflows) and adds.github/to.Rbuildignore. It's set to error only on error now, and is working. Open questions for core team:mainand leave these out of thedevelbranch. Seems unnecessarily complicated to me.codecov? Easy to do but needs a README.md and badge to be useful.