Debian Codegraph @

docs/README_CI.md

raw
1 # LibGD CI
2
3 LibGD uses github actions for CI.
4
5 The platforms used are:
6 - Ubuntu 20.04LTS, Intel
7 - https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md
8 - GCC (x64)
9 - CLang (x64)
10 - Ubuntu 20.04LTS, ARM (graviton2)
11 - AWS Ubuntu Image
12 - GCC (64bit)
13 - CLang (64bit)
14 - Windows Server 2019, x64
15 - https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md
16 - Visual Studio Enterprise 2019 (x64, x86 and arm64 cross compiliations)
17 - MingW GCC (x86, x64 and ucrt64)
18 - MacOS 11, Intel
19 - https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11-Readme.md
20 - GCC x64
21 - MacOS 11, M1 in place but we don't manage to get M1 runners
22
23 The CI configurations and script can be found in
24
25 ```
26 .gihub/workflows
27 ```
28
29 ## Where are they used
30
31 The actions work on:
32 - master push
33 - any new pull requests
34 - GD3 (branch surface/surface)
35
36 Please do not merge pull requests can be merged if any of the CI failed.
37
38 ## ci_ubuntu
39
40 This file contains all Linux/Ubuntu configurations. The dependencies are installed using apt. Some libraries may use non official Ubuntu repositories to get the latest versions.
41
42 ## ci_windows.yml
43
44 It contains all jobs and matrices for VS builds (cross compilations included).
45
46 Dependencies are installed using archived VCPKG libraries, from:
47
48 https://github.com/libgd/libgd-windows-vcpkg-prebuild
49
50 For x64, x86 and arm64.
51
52 ## ci_windows.yml
53
54 ## ci_macos.yml
55
56 All configs for MacOS. Dependencies are installed using homebrew (for those not available already in the image).
57
58 Important note:
59
60 Github actions MacOS images contain Mono. Mono somehow messes up with the various paths and it is not worth figuring out how to work around it. We use a script to simply remove Mono from the system, the script can be found in .github\scripts\removemono.sh
61
62 ## shellcheck.yml
63
64 CI to valid shell scripts syntax, portability or other possible issues. It uses https://www.shellcheck.net/.
65
66 If a script is needed with some shell specific features which are raised as error by shellcheck, please use the ignore rules in the top of the script or at the required line(s). For an example, removemono.sh contains such rules.