Better use of golden files in CI

[smelc]

Changelog

- description: |
    Better use of golden files in CI
# uncomment types applicable to the change:
  type:
  # - feature        # introduces a new feature
  # - breaking       # the API has changed in a breaking way
  # - compatible     # the API has changed but is non-breaking
  # - optimisation   # measurable performance improvements
  # - improvement    # QoL changes e.g. refactoring
  # - bugfix         # fixes a defect
  - test           # fixes/modifies tests
  - maintenance    # not directly related to the code
  # - release        # related to a new release preparation
  # - documentation  # change in code docs, haddocks...

Context

• This PR avoids an extra testing step (by checking golden files for modifications)
• This PR reports golden files that are useless (because they didn't get generated)

How to trust this PR

• Look at Test PR for improving golden CI (1/2) #722 and see that the last commit catches that some golden files are not up-to-date.
• Look at Test PR for improving golden CI (2/2) #723 and see that the CI catches golden files that are not being used anymore

Checklist

• Commit sequence broadly makes sense and commits have useful messages
• Self-reviewed the diff

[palas]

Nice improvement. I also tried the scripts manually and they work. My two cents are two suggestions about presentation.

[palas]

Suggested change

	echo "💣 The following golden files are not up-to-date:"
	git ls-files -m
	echo "Please run the tests locally and update the golden files, or fix your changes."
	echo "💣 The following golden files are not up-to-date:"
	echo -e
	git ls-files -m
	echo -e
	echo "These are the changes that were made:"
	echo -e
	git diff
	echo -e
	echo "Please run the tests locally and update the golden files, or fix your changes."

In addition to the previous suggestion, it may be useful to display the diff. That way you can see what the differences look like. So, for example, if it is a whitespace change, it may be obvious you are missing pretty-printing them. Or if a particular key in the JSON is wrong.

[smelc]

I rather keep the output of the CI short, so I will skip this one 👍

[newhoggy]

Not sure why all the Windows CI fails.

[carbolymer]

Seems this is a problem for windows: https://github.com/IntersectMBO/cardano-cli/blob/main/cardano-cli/test/cardano-cli-golden/Test/Golden/Help.hs#L54

[smelc]

Yep, I simply disabled the new checks on Windows: ad0b99a

[Jimbo4350]

Nice 👍