Skip to content

Commit 1db5105

Browse files
korbinian90pzeidman
authored andcommitted
Add automatic MEX compilation entry
1 parent 2b061f2 commit 1db5105

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/development/compilation/index.md

+15
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,18 @@ Platform-specific throubleshooting is available with the links above. We list he
1919
!!! failure "`bad image handle dimensions` error"
2020

2121
The error "`bad image handle dimensions`" when trying to display an image is an indication that the MEX files are not compatible with your platform and should be recompiled.
22+
23+
## Automatic recompilation on GitHub Actions
24+
25+
!!! info "How is the recompilation triggered?"
26+
27+
If new c files or changes are pushed to main, the [compile MEX](https://github.com/spm/spm/actions/workflows/compile_mex.yml) action will automatically run and recompile all MEX files. In can also be triggered manually, which works for a any branch.
28+
29+
The compiled MEX files will be available as zip a file under the [compile MEX](https://github.com/spm/spm/actions/workflows/compile_mex.yml) action by selecting the corresponding run of the action and downloading the spm-mex-all.zip file. It contains compiled MEX files for Windows, Linux, MacOS (Intel) and MacOS (Apple Silicon).
30+
31+
The suggested steps after changing or adding new c code is:
32+
1. Confirm that the [automatic tests](https://github.com/spm/spm/actions/workflows/matlab.yml) still succeed
33+
2. Download the [automatically compiled MEX files](https://github.com/spm/spm/actions/workflows/compile_mex.yml)
34+
3. Manually add the MEX files of the corresponding change to the SPM repository (.mexa64, .mexmaca64, .mexmaci64, .mexw64)
35+
36+
Note: Currently, the action doesn't compile the external c dependencies. This is because of a problem of compiling the fieldtrip dependency on windows.

0 commit comments

Comments
 (0)