Skip to content

Bioconductor/workflows

Repository files navigation

Bioconductor GitHub Actions Workflows

Actionlint Canary Check

This repository (bioconductor/workflows) hosts reusable GitHub Actions workflows for R/Bioconductor package development.

NOTE: This is pre-release. Please try it and file issues, but some things may not work yet. The first stable release will be tagged v1.

Overview: Two Complementary Testing Patterns

Two complementary workflows are available depending on your testing goals:

Purpose Workflow Reference Target Environment Managed By
1. Rapid Feedback Check bioconductor/workflows/.github/workflows/bioccheck.yml@main Linux (bioconductor_docker container) Bioconductor Core Team / Maintainers
2. Comprehensive Pre-Release Check r-universe-org/workflows/.github/workflows/build.yml@v3 Multi-OS (Linux, macOS, Windows, WebAssembly) + BiocCheck R-Universe Team

Documentation

The documentation for these workflows has been separated into distinct files for clarity:

  • BiocCheck Usage: Comprehensive instructions for using the bioccheck.yml reusable workflow, including test coverage and pkgdown setup.
  • R-Universe Usage: Instructions for using the comprehensive multi-platform R-Universe workflow.
  • Workflow Comparison: A detailed comparison of the two workflows to help you choose the right one for your needs.
  • Technical Notes: Software architecture, ADRs, internal test flows (canary.yml, actionlint.yml), and guidelines for contributors.

About

Reusable workflows for checking Bioconductor packages

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors