Skip to content

ci: add GitHub Actions workflow and .Rbuildignore - #120

Merged
vjcitn merged 4 commits into
develfrom
ci/add-github-actions-workflow
Jul 27, 2026
Merged

ci: add GitHub Actions workflow and .Rbuildignore#120
vjcitn merged 4 commits into
develfrom
ci/add-github-actions-workflow

Conversation

@lwaldron

@lwaldron lwaldron commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Adds .github/workflows/ci.yml using 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:

  1. OK to add .github/ directory and probably a README.md to display status badges, with these added to .Rbuildignore? Alternative is to make the default branch for active development main and leave these out of the devel branch. Seems unnecessarily complicated to me.
  2. add codecov? Easy to do but needs a README.md and badge to be useful.

Copilot AI review requested due to automatic review settings July 27, 2026 10:05

Copilot AI 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.

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.yml to run PR CMD check and (on selected pushes) build the pkgdown site via a reusable workflow.
  • Add .github/ to .Rbuildignore so 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 paths glob **.yml does not reliably match .yml files 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, pin uses: to a tag or full commit SHA from waldronlab/.github instead 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 for pull_request runs) 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.

Comment thread .Rbuildignore Outdated
Comment thread .github/workflows/ci.yml Outdated
Comment on lines +5 to +11
push:
paths:
- 'DESCRIPTION'
- '**.yml'
branches:
- devel
- 'RELEASE_*'
@lwaldron
lwaldron force-pushed the ci/add-github-actions-workflow branch from 39a9efd to bac8bd8 Compare July 27, 2026 10:08
@lwaldron
lwaldron requested a review from Copilot July 27, 2026 10:11
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI 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.

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

  • .Rbuildignore entries 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 .github directory.
^\.github$

Comment thread .github/workflows/ci.yml
@lwaldron
lwaldron requested a review from vjcitn July 27, 2026 10:41

@vjcitn vjcitn 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 am fine with these changes. Longer term we should arrange two signoffs from core.

@vjcitn
vjcitn merged commit 7c5b265 into devel Jul 27, 2026
3 checks passed
@vjcitn

vjcitn commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Merging, hoping version was bumped.

@lwaldron

Copy link
Copy Markdown
Contributor Author

No version bump because there was no change to the built .tar.gz package.

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