CCBR actions 🤖

GitHub Actions for CCBR repos

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.

• add-issue-label-list
• auto-format
• build-docker-auto
• build-docker-manual
• build-nextflow
• build-python
• build-snakemake
• docs-mkdocs
• docs-quarto
• draft-release
• label-issues-repo-name
• post-release
• techdev-project
• update-cff-R
• user-projects

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
• draft-release - Draft a new release based on conventional commits and prepare release notes
• label-issue-repo-name - Label issues & PRs with the repository name
• mkdocs-mike - Deploy documentation to github pages using mkdocs + mike
• post-release - Post-release cleanup chores, intended to be triggered by publishing a release

Package

This repo contains a python package with helper functions for some of our custom actions. You do not need to install anything 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.

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/actions

Or install it from a specific version or branch with:

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

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., Koparde V. (2024). CCBR actions: GitHub Actions for CCBR repos (version v0.2.2). 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 = {11},
title = {CCBR actions: GitHub Actions for CCBR repos},
url = {https://ccbr.github.io/actions/},
year = {2024}
}

Inspiration

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