GitHub Actions builds C-PAC images for each branch and tag pushed to GitHub; these images are pushed to GHCR and deleted upon branch deletion on GitHub.
If a commit is pushed or merged into develop on GitHub, GitHub Actions will push nightly and its variants to Docker Hub.
If a tag is pushed to GitHub that matches the regular expression
^v[0-9]+\.[0-9]+\.[0-9]+$
GitHub Actions will push release-${TAG} and its variants and latest and its variants to Docker Hub.
We currently have one main and 3 variant images:
ABCD-HCP: dependency versions matched to ABCD-HCP BIDS fMRI Pipeline versionsfMRIPrep-LTS: dependency versions matched to fMRIPrep Long-term support versionslite: same dependency versions as main image without FreeSurfer (smaller image)
To save time building Docker images, our continuous integration is set up to build and store staging images independent of changes to C-PAC itself. Images are rebuilt when their Dockerfile changes on a Git branch.
All Dockerfiles are stored in .github/Dockerfiles.
We have 3 types of staging Dockerfiles: operating system, software dependency, and C-PAC variant.
{OS name}.{version}.Dockerfile
{software name}.{version}-{OS version}.Dockerfile
C-PAC.{version}[-{variant}]-{OS version}.Dockerfile (-{variant} is omitted for the main image)
- To change a dependency in a C-PAC image, update the stage images at the top of the relevant
.github/Dockerfiles/C-PAC.develop-*.Dockerfile. - If a Dockerfile does not yet exist for the added dependency, create a Dockerfile for the new dependency and add the filename (without extension) to
jobs.stages.strategy.matrix.Dockerfilein.github/workflows/build_stages.yml - If no Dockerfiles use the removed dependency, remove the Dockerfile for the dependency and remove the filename from
jobs.stages.strategy.matrix.Dockerfilein.github/workflows/build_stages.yml