.github/workflows/README.md

   1
   2 ## The testings are done this way
   3
   4 ```mermaid
   5 flowchart TB
   6 subgraph CleanUp and Summary
   7   Part1-20.04-->CleanUp+nice+Summary
   8   Part2-20.04-->CleanUp+nice+Summary
   9   PartN-20.04-->CleanUp+nice+Summary
  10   Part1-22.04-->CleanUp+nice+Summary
  11   Part2-22.04-->CleanUp+nice+Summary
  12   PartN-22.04-->CleanUp+nice+Summary
  13 end
  14
  15 subgraph Functional Testings
  16   functional-testing-20.04-->Part1-20.04
  17   functional-testing-20.04-->Part2-20.04
  18   functional-testing-20.04-->PartN-20.04
  19   functional-testing-22.04-->Part1-22.04
  20   functional-testing-22.04-->Part2-22.04
  21   functional-testing-22.04-->PartN-22.04
  22 end
  23
  24 subgraph Sanity and zloop Testings
  25   sanity-checks-20.04-->functional-testing-20.04
  26   sanity-checks-22.04-->functional-testing-22.04
  27   zloop-checks-20.04-->functional
  28   zloop-checks-22.04-->functional
  29 end
  30
  31 subgraph Code Checking + Building
  32   codeql.yml
  33   checkstyle.yml
  34   Build-Ubuntu-20.04-->sanity-checks-20.04
  35   Build-Ubuntu-22.04-->sanity-checks-22.04
  36   Build-Ubuntu-20.04-->zloop-checks-20.04
  37   Build-Ubuntu-22.04-->zloop-checks-22.04
  38 end
  39 ```
  40
  41
  42 1) build zfs modules for Ubuntu 20.04 and 22.04 (~15m)
  43 2) 2x zloop test (~10m) + 2x sanity test (~25m)
  44 3) functional testings in parts 1..5 (each ~1h)
  45 4) cleanup and create summary
  46    - content of summary depends on the results of the steps
  47
  48 When everything runs fine, the full run should be done in
  49 about 2 hours.
  50
  51 The codeql.yml and checkstyle.yml are not part in this circle.