|
| 1 | +# C-PAC/.github README |
| 2 | + |
| 3 | +This directory contains Dockerfiles, scripts, requirements files, and workflow configurations for [this repository's GitHub Actions](https://github.com/FCP-INDI/C-PAC/actions). |
| 4 | + |
| 5 | +When updating these files, please update this README as necessary. |
| 6 | + |
| 7 | +[The `workflows` directory](./workflows) contains the configurations for the Actions themselves. The other directories support these configs. |
| 8 | + |
| 9 | +```mermaid |
| 10 | +flowchart TD |
| 11 | + subgraph Dockerfiles |
| 12 | + base[base-.*] |
| 13 | +
|
| 14 | + cpacdockerfiles["C-PAC.develop-(?!lite).*"] |
| 15 | +
|
| 16 | + cpaclitedockerfile[C-PAC.develop-lite.*] |
| 17 | +
|
| 18 | + stagedockerfiles[AFNI.*\nANTs.*\nc3d.*\nconnectome-workbench.*\nFSL.*\nICA-AROMA.*\nmsm.*] |
| 19 | +
|
| 20 | + ubuntudockerfiles[Ubuntu.*] |
| 21 | + end |
| 22 | + subgraph scripts |
| 23 | + get_package_id.py |
| 24 | + get_pr_base_shas |
| 25 | + local_ghcr |
| 26 | + end |
| 27 | + subgraph smoke_test_participant.yml |
| 28 | + smoke_test_human |
| 29 | + smoke_test_nhp |
| 30 | + smoke_test_rodent |
| 31 | + end |
| 32 | + subgraph stage_requirements |
| 33 | + .*.txt |
| 34 | + end |
| 35 | + subgraph workflows |
| 36 | + subgraph build_stages.yml |
| 37 | +
|
| 38 | + ubuntu[[Ubnutu]]-->stages[[stages]]-->build-base[[build-base]] |
| 39 | +
|
| 40 | + end |
| 41 | + subgraph build_C-PAC.yml |
| 42 | + bCPAC[[C-PAC]] |
| 43 | + end |
| 44 | + subgraph build_and_test.yml |
| 45 | + Circle_tests[[Circle_tests]] |
| 46 | + |
| 47 | + C-PAC[[C-PAC]]-->bCPAC |
| 48 | + C-PAC-->Circle_tests |
| 49 | + C-PAC-->smoke-tests-participant |
| 50 | + C-PAC-->C-PAC-lite |
| 51 | +
|
| 52 | + C-PAC-lite[[C-PAC-lite]]-->bCPAC |
| 53 | + C-PAC-lite-->Circle_tests |
| 54 | + C-PAC-lite-->smoke-tests-participant |
| 55 | +
|
| 56 | + C-PAC-ABCD-HCP[[C-PAC-ABCD-HCP]]-->bCPAC |
| 57 | + C-PAC-ABCD-HCP-->Circle_tests |
| 58 | + C-PAC-ABCD-HCP-->smoke-tests-participant |
| 59 | +
|
| 60 | + C-PAC-fMRIPrep[[C-PAC-fMRIPrep-LTS]]-->bCPAC |
| 61 | + C-PAC-fMRIPrep-->Circle_tests |
| 62 | + C-PAC-fMRIPrep-->smoke-tests-participant |
| 63 | +
|
| 64 | + smoke-tests-participant[[smoke-tests-participant]] |
| 65 | + end |
| 66 | +
|
| 67 | + check_updated_preconfigs.yml-->build_stages.yml |
| 68 | +
|
| 69 | + delete_images.yml |
| 70 | + end |
| 71 | +
|
| 72 | + subgraph yaml_template[CPAC/utils/configuration/yaml_template.py] |
| 73 | +
|
| 74 | + update_all_preconfigs[[update_all_preconfigs]] |
| 75 | + end |
| 76 | +
|
| 77 | + base<-->build-base |
| 78 | +
|
| 79 | + Circle_tests-->CircleCI((Run tests on Circle CI)) |
| 80 | +
|
| 81 | + build_stages.yml-->build_and_test.yml |
| 82 | +
|
| 83 | + check_updated_preconfigs.yml<-->get_pr_base_shas |
| 84 | + check_updated_preconfigs.yml-->update_all_preconfigs |
| 85 | +
|
| 86 | + cpacdockerfiles<-->C-PAC |
| 87 | + cpacdockerfiles<-->C-PAC-ABCD-HCP |
| 88 | + cpacdockerfiles<-->C-PAC-fMRIPrep |
| 89 | +
|
| 90 | + cpaclitedockerfile<-->C-PAC-lite |
| 91 | +
|
| 92 | + delete>delete branch]-->delete_images.yml |
| 93 | +
|
| 94 | + delete_images.yml<-->get_package_id.py |
| 95 | +
|
| 96 | + build-base<-->local_ghcr |
| 97 | + bCPAC<-->local_ghcr |
| 98 | + stages<-->local_ghcr |
| 99 | +
|
| 100 | + push>git push]-->check_updated_preconfigs.yml |
| 101 | +
|
| 102 | + smoke-tests-participant-->smoke_test_human |
| 103 | + smoke-tests-participant-->smoke_test_nhp |
| 104 | + smoke-tests-participant-->smoke_test_rodent |
| 105 | +
|
| 106 | + stagedockerfiles<-->stages |
| 107 | +
|
| 108 | + build-base<-->.*.txt |
| 109 | +
|
| 110 | + ubuntudockerfiles<-->ubuntu |
| 111 | +``` |
| 112 | + |
| 113 | +In this [Mermaid flowchart](https://mermaid.js.org/syntax/flowchart.html), these shapes are used: |
| 114 | + |
| 115 | +concept | shape |
| 116 | +---|--- |
| 117 | +directory | `subgraph` |
| 118 | +file | rectangle (`[]`) or `subgraph` |
| 119 | +workflow job | subprocess (`[[]]`) |
| 120 | +trigger action | asymetric (`>]`) |
| 121 | +external API | circle (`(())`) |
0 commit comments