Skip to content
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

Update integration checks to use satijalab/seurat-ci Docker image #228

Merged
merged 6 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,5 @@
^.*\.Rds$
^data-raw$
^inst$
^tests$
^LICENSE\.md$
^vignettes/articles$
62 changes: 18 additions & 44 deletions .github/workflows/integration_checks.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
name: Integration Checks

# because `main` is a protected branch this workflow is triggered when a PR
# is opened/updated and again when it is merged
# Because `main` is a protected branch this workflow is triggered when a PR
# is opened/updated and again when it is merged.
on:
push:
branches:
Expand All @@ -14,57 +12,33 @@ on:

jobs:
check-package:
# system dependencies for cannot be automatically resolved by
# `r-lib/actions/setup-r@v2` for macos or windows - to avoid having to
# maintain separate logic to infer and install system of those operating
# systems we'll only run integration checks with the ubuntu
runs-on: ubuntu-latest

# run integration checks with R-release, R-devel, and R-oldrelease
strategy:
matrix:
r-version: ['release', 'devel', 'oldrel']

# Use the `satijalab/seurat-ci` Docker image as the runner environment.
# This image is pre-configured with everything required for running
# integration checks, for more details, see
# https://hub.docker.com/repository/docker/satijalab/seurat-ci/general.
container:
image: satijalab/seurat-ci:latest

steps:
# pull the latest changes from the repository down to the runner
# Pull the latest changes from the repository down to the runner.
- name: Checkout
uses: actions/checkout@v4

# install R and any system dependencies
- name: Setup R
uses: r-lib/actions/setup-r@v2
with:
# install the R version specified by the current strategy
r-version: ${{ matrix.r-version }}
# specify additional repositories to pull dependencies not
# available on CRAN (i.e. `BPCells`)
extra-repositories: ${{ 'https://bnprks.r-universe.dev' }}

# install R dependencies
# Install the package and all its dependencies using scripts from
# `littler`, see https://eddelbuettel.github.io/littler/ for details.
# `Seurat` is listed under "Enhances" so it also needs to be installed.
- name: Install Dependencies
uses: r-lib/actions/setup-r-dependencies@v2
with:
extra-packages:
any::rcmdcheck
any::pkgdown
# installed packages are cached by default - force an upgrade to the
# latest version of all dependencies
upgrade: 'TRUE'
run: installDeps.r -s && install.r Seurat

# run CRAN checks - fails if any ERRORs or WARNINGs are raised in which
# case the `rcmdcheck` output will be uploaded as an artifact
# Run CRAN checks, if any ERRORs or WARNINGs are raised the check fails.
- name: Run Checks
uses: r-lib/actions/check-r-package@v2
env:
# suppress NOTEs that are accepted by CRAN
# see: https://www.rdocumentation.org/packages/rcmdcheck/versions/1.4.0/topics/rcmdcheck
_R_CHECK_PKG_SIZES_: false
_R_CHECK_RD_XREFS_: false
_R_CHECK_CRAN_INCOMING_NOTE_GNU_MAKE_: false
_R_CHECK_PACKAGE_DATASETS_SUPPRESS_NOTES_: true
run: rcmdcheck::rcmdcheck(args = "--as-cran", error_on="warning")
shell: Rscript {0}
continue-on-error: true

# build pkgdown site
# Build the `pkgdown` site, if any errors are raised the check fails.
- name: Build Website
run: |
pkgdown::build_site_github_pages(
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: SeuratObject
Type: Package
Title: Data Structures for Single Cell Data
Version: 5.0.99.9001
Version: 5.0.99.9002
Authors@R: c(
person(given = 'Paul', family = 'Hoffman', email = '[email protected]', role = 'aut', comment = c(ORCID = '0000-0002-7693-8957')),
person(given = 'Rahul', family = 'Satija', email = '[email protected]', role = c('aut', 'cre'), comment = c(ORCID = '0000-0001-9448-8833')),
Expand Down
4 changes: 2 additions & 2 deletions tests/testthat.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
library(testthat)
library(Seurat)
library(SeuratObject)

test_check("Seurat")
test_check("SeuratObject")
Loading