CCBR actions 🤖

GitHub Actions for CCBR repos

Custom GitHub Actions and example workflows for CCBR repositories. View our documentation website for implementation details. View the GitHub Actions docs for information on how to write and use GitHub Actions workflows.

Examples

See examples/ for workflow examples. You can copy these to your own repository in the .github/workflows/ directory and modify them for your needs.

• R-CMD-check
• add-issue-label-list
• auto-format
• build-docker-auto
• build-docker-dispatch
• build-docker-manual
• build-nextflow
• build-python
• build-snakemake
• changed-files
• check-links
• copy-ruleset
• docs-mkdocs
• docs-quarto
• draft-release

Actions

Custom actions used in our github workflows.

• add-issue-label-list - Update issue description with a list of issues of a given label
• build-docker - Build a docker container using CCBR guidelines
• Changed Files - Get a list of changed files and filter them by a list of path patterns similar to .gitignore
• Copy Ruleset - Copy a repository ruleset from one GitHub repository to another.
• draft-release - Draft a new release based on conventional commits and prepare release notes
• Install R + pak - Install R package dependencies with pak
• label-issue-repo-name - Label issues & PRs with the repository name
• maintain-milestones - Maintain rolling monthly milestones in a target repository
• mkdocs-mike - Deploy documentation to github pages using mkdocs + mike
• post-release - Post-release cleanup chores, intended to be triggered by publishing a release
• review-post-release-pr - Review a post-release cleanup PR: approve pending workflow runs, approve, and enable auto-merge when only version/date bumps matching a real release tag are present, otherwise request a human reviewer
• review-pre-commit-pr - Review a pre-commit.ci autoupdate PR: approve and attempt auto-merge when only rev: versions changed (or a rev alias tag points at the same commit), otherwise request a human reviewer

Package

ccbr_actions is a Python package with helper functions used by our custom GitHub Actions. You do not need to install the package in order to use the example workflows, as the actions install their dependencies as needed. However, you can install the package if you wish to use it outside of GitHub Actions or contribute changes.

View the package documentation here.

Installation

You will need the GitHub CLI installed (this is pre-installed on all github actions runners): https://github.com/cli/cli#installation

Then install the ccbr_actions package with pip:

pip install git+https://github.com/CCBR/[email protected]

Or use the provided docker image with your preferred container engine:

podman run docker://nciccbr/ccbr_actions@latest \
  ccbr_actions --version

Command line interface

You can copy example workflows to your project with ccbr_actions use-example:

Usage: ccbr_actions use-example [OPTIONS] NAME

  Use a GitHub Actions workflow file from CCBR/actions.

  Args:
      name (str): The name of the example workflow file to download.

  Examples:
      ccbr_actions use-example docs-mkdocs
      ccbr_actions use-example build-nextflow

  See list of workflow files here:
  https://ccbr.github.io/actions/examples.html

Options:
  -h, --help  Show this message and exit.

View the full CLI usage here.

Help & Contributing

Come across a bug? Open an issue and include a minimal reproducible example.

Have a question? Ask it in discussions.

Want to contribute to this project? Check out the contributing guidelines.

Citation

Please cite this software if you use it in a publication:

Sovacool K. and Koparde V. (2026). CCBR actions: GitHub Actions for CCBR repos (version v0.8.3). DOI: 10.5281/zenodo.13761059 URL: https://ccbr.github.io/actions/

Bibtex entry

@misc{YourReferenceHere,
author = {Sovacool, Kelly and Koparde, Vishal},
doi = {10.5281/zenodo.13761059},
month = {10},
title = {CCBR actions: GitHub Actions for CCBR repos},
url = {https://ccbr.github.io/actions/},
year = {2026}
}

Inspiration

This project was inspired by r-lib/actions and {usethis}. Check them out for actions, workflows, and helper functions for R packages!