gha: Print all *.log files, in a separate action #1655

1. 
   real-or-random commented at 9:34 am on March 10, 2025: contributor

   Before this commit, we didn’t print *_example.log files and test_suite.log.

   Printing is now handled in a separate action, which avoids code duplication and makes the ci.yml file more readable. This changes the folding/grouping of the log output in the GitHub Actions CI, but I think the new variant is as good as the old one.

   Furthermore, the condition for printing the logs is changed from “always()” to “!cancelled()”. This ensures that logs will still be printed if previous steps such as the CI script failed, but that they won’t be printed if the entire run is cancelled (e.g., by clicking a button in the UI or through a force-push to the PR). This is in line with a recommendation in the GHA docs: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/evaluate-expressions-in-workflows-and-actions#always

2. real-or-random added the label ci on Mar 10, 2025
3. real-or-random added the label assurance on Mar 10, 2025
4. real-or-random force-pushed on Mar 10, 2025
5. real-or-random force-pushed on Mar 10, 2025
6. real-or-random force-pushed on Mar 10, 2025
7. real-or-random force-pushed on Mar 10, 2025
8. real-or-random force-pushed on Mar 10, 2025
9. real-or-random force-pushed on Mar 10, 2025
10. real-or-random force-pushed on Mar 10, 2025
11. real-or-random force-pushed on Mar 10, 2025
12. real-or-random renamed this:
    ci: Print *_example.log and test-suite.log
    gha: Print all *.log files, in a separate action
    on Mar 10, 2025
13. real-or-random marked this as ready for review on Mar 10, 2025
14. 
    real-or-random commented at 4:52 pm on March 10, 2025: contributor

    Ready for review (if CI passes :)).

    If you prefer, I could split the changes into separate commits, but I don’t think it’s worth the hassle. It’s not entirely clear how to separate these changes, and doing so would increase the sum of the diff because later commits will need to touch lines moved in earlier commits.

15. 
    real-or-random commented at 4:53 pm on March 10, 2025: contributor

    @hebasto Can you take a look at this?
16. in .github/actions/print-logs/action.yml:29 in 8960c5ee07 outdated

    21+
    22+        # Print all *.log files
    23+        shopt -s nullglob
    24+        for file in *.log; do
    25+            cat_file "$file"
    26+        done
    

    ---

    ---

    

    hebasto commented at 5:20 pm on March 10, 2025:

    The make.log file is now printed along with other logs.

    Does it make sense to separate logs by groups:

    • config.log and make.log
    • tests and benchmarks
    • examples

    ?

    ---

    

    real-or-random commented at 8:05 pm on March 10, 2025:

    I agree that this would produce better output, but I also think that *.log is good enough and much easier to maintain.
17. in .github/actions/print-logs/action.yml:11 in 8960c5ee07 outdated

    0@@ -0,0 +1,31 @@
    1+name: "Print logs"
    2+description: "Print the log files produced by ci/ci.sh"
    3+runs:
    4+  using: "composite"
    5+  steps:
    6+    - shell: bash
    7+      run: |
    8+        group() {
    

    ---

    ---

    

    hebasto commented at 5:22 pm on March 10, 2025:

    The first line of the run command is printed as a group header in the Web interface. It could be a meaningful comment, for example: # Print the log files produced by ci/ci.sh.

    ---

    

    real-or-random commented at 8:10 pm on March 10, 2025:

    Yeah, it’s annoying that it’s not possible to get rid of this line, but making it contain a comment is a great idea. Fixed.
18. 
    hebasto commented at 5:23 pm on March 10, 2025: member

    Concept ACK.
19. gha: Print all *.log files, in a separate action

    Before this commit, we didn't print *_example.log files and
    test_suite.log.
    
    Printing is now handled in a separate action, which avoids code
    duplication and makes the ci.yml file more readable. This changes the
    folding/grouping of the log output in the GitHub Actions CI, but I
    think the new variant is as good as the old one.
    
    Furthermore, the condition for printing the logs is changed from
    "always()" to "!cancelled()". This ensures that logs will still be
    printed if previous steps such as the CI script failed, but that they
    won't be printed if the entire run is cancelled (e.g., by clicking a
    button in the UI or through a force-push to the PR). This is in line
    with a recommendation in the GHA docs:
    https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/evaluate-expressions-in-workflows-and-actions#always

    59860bcc24
20. real-or-random force-pushed on Mar 10, 2025
21. hebasto approved
22. 
    hebasto commented at 11:40 am on March 11, 2025: member

    ACK 59860bcc24814a4779be5688fce03bc6385faf87.
23. 
    sipa commented at 12:57 pm on March 11, 2025: contributor

    ACK 59860bcc24814a4779be5688fce03bc6385faf87
24. real-or-random merged this on Mar 11, 2025
25. real-or-random closed this on Mar 11, 2025

    ---

Contributors
real-or-random hebasto sipa

Labels
assurance ci