CI.md

   1 # CI Information
   2
   3 The CI workflows and checks, and associated container environments for this repository
   4 are listed below.
   5 Actions run via Github-hosted runners unless otherwise noted.
   6 Required CI for pull requests are listed first.
   7
   8 ## Pull Request CI and checks
   9
  10 ### Build libFMS with autotools
  11 Required GNU build test for all pull requests/pushes.
  12 Runs `make distcheck` after configuring via GNU autotools.
  13
  14 Container environment:
  15 gcc            v7.3.0
  16 mpich          v3.3a2
  17 netcdf         v4.6.0
  18 netcdf-fortran v4.4.4
  19 autoconf       v2.69
  20
  21 container hosted at [noaagfdl/ubuntu_libfms_gnu:latest](https://hub.docker.com/r/noaagfdl/ubuntu_libfms_gnu)
  22
  23 `./configure` flags:
  24 - `--enable-openmp`
  25 - `--disable-openmp`
  26 - `--enable-mixed-mode`
  27 - `--disable-setting-flags`
  28 - `--with-yaml`
  29
  30 ### Build libfms with cmake
  31 Required GNU build test for all pull requests/pushes.
  32 Runs `make` after configuring via cmake.
  33
  34 Container environment:
  35 gcc            v7.3.0
  36 mpich          v3.3a2
  37 netcdf         v4.6.0
  38 netcdf-fortran v4.4.4
  39 cmake          v3.22.0
  40
  41 container hosted at [noaagfdl/ubuntu_libfms_gnu:latest](https://hub.docker.com/r/noaagfdl/ubuntu_libfms_gnu)
  42
  43 cmake flags:
  44 - `-DOPENMP=on`
  45 - `-DOPENMP=on`
  46 - `-DWITH_YAML=on`
  47 - `-D64BIT=on`
  48
  49 ### libFMS lint tests
  50 Required test for all pull requests.
  51 Checks code for line lengths, tabs, and trailing whitespace in accordance with
  52 the project's [style guide](https://github.com/NOAA-GFDL/FMS/blob/main/CODE_STYLE.md).
  53 The action is hosted on github [here](https://github.com/NOAA-GFDL/simple_lint).
  54
  55 ## Parallelworks CI
  56 The following CI workflows run on self-hosted runners through the parallelworks platform.
  57 ### Pull Request CI libFMS with intel
  58 Optional(does not need to pass to merge) intel build test hosted on the parallelworks platform.
  59 Runs `make check` with intel 18 and 21 compilers for all pull requests.
  60
  61 ### Tag CI libFMS with AM4 regression
  62 On alpha or beta tag creation, compiles and runs full AM4 model regression testing using the new FMS tag on parallelworks.