GitHub Actions for CCBR repos
See examples/ for workflow examples. You can copy these to
your own repository in the .github/workflows/ directory and modify
them for your needs.
- auto-format
- build-nextflow
- build-python
- build-snakemake
- docs-mkdocs
- docs-quarto
- draft-release
- post-release
- techdev-project
- user-projects
Custom actions used in our github workflows.
- draft-release - Draft a new release based on conventional commits and prepare release notes
- mkdocs-mike - Deploy documentation to github pages using mkdocs + mike
- post-release - Post-release cleanup chores, intended to be triggered by publishing a release
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.
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/actionsOr install it from a specific version or branch with:
pip install git+https://github.com/CCBR/actions@v0.1Come 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.
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.1.3). DOI: 10.5281/zenodo.13761059 URL: https://ccbr.github.io/actions/
@misc{YourReferenceHere,
author = {Sovacool, Kelly and Koparde, Vishal},
doi = {10.5281/zenodo.13761059},
month = {9},
title = {CCBR actions: GitHub Actions for CCBR repos},
url = {https://ccbr.github.io/actions/},
year = {2024}
}