Skip to content

Commit 67b3a6a

Browse files
committed
📝 Document multistage-CI
1 parent 25dd533 commit 67b3a6a

File tree

4 files changed

+11
-1
lines changed

4 files changed

+11
-1
lines changed

docs/_sources/_static/flowcharts/CI-flow.svg

Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Continuous Integration
2+
======================
3+
4+
Our continous integration flow relies on GitHub Actions, GitHub Container Registry, CircleCI and Docker Hub. GitHub Actions builds staging images based on changes to Dockerfiles and pushes those images to GitHub Container Registry. On each push, once staging images are built or determined to be up to date, GitHub Actions installs C-PAC into a development image for each variant (standard, lite, fMRIPrep-LTS, and ABCD-HCP). CircleCI runs tests in both Docker and Singularity for each of these images and generates a coverage report if all tests pass. On release, CircleCI also pushes production images to Docker Hub.
5+
6+
.. raw:: html
7+
8+
<div class="flowchart-container"><object data="../_static/flowcharts/CI-flow.svg" type="image/svg+xml"></object></div>

docs/_sources/developer/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Contents:
2424
workflows/index
2525
xcpqc
2626
testing
27+
continuous_integration
2728

2829
Indices and tables
2930
^^^^^^^^^^^^^^^^^^

docs/_sources/user/subject_list_config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The Singularity command will create ``data_settings.yml`` in the current working
4141

4242
The Docker command requires a few more parameters than the Singularity command:
4343

44-
* ``--user $(id -u)`` is necessary so the generated files will be owned locally by the user running Docker rather than by root (the default).
44+
* ``--user $(id -u)`` is necessary so the generated files will be owned locally by the user running Docker rather than by ``c-pac_user`` (the default).
4545
* ``-v /path/to/data_config:/scratch`` binds your local ``data_config`` directory to ``/scratch`` on the Docker image, and
4646
* ``-w="/scratch"`` sets the current working directory on the Docker image to ``/scratch``.
4747

0 commit comments

Comments
 (0)