GitHub action around the command-line interface of fieldcompare (or see the GitHub mirror). This allows an easy integration of regression tests into your workflows.

Usage

Comparing two files in your workflows is as simple as this:

- name: regression-test
  uses: dglaeser/fieldcompare-action@v1
  with:
    result: "file.csv"
    reference: "reference_file.csv"

fieldcompare also supports comparing all files with matching file names in two given folders. The action automatically determines if the given arguments for results and reference are directories and compares all contents of the given folders in that case. fieldcompare also has a bunch of options that you can pass, for instance, to set custom fuzzy tolerances, exclude certain fields or files from being compared, etc. This action accepts the input cli-options that allows you to pass all options you would like to set as a single string. For instance, to overwrite the default relative and absolute tolerance and setting specific tolerances to be used for all fields with the name pressure, you could write:

- name: regression-test
  uses: dglaeser/fieldcompare-action@v1
  with:
    result: "file.csv"
    reference: "reference_file.csv"
    cli-options: "-rtol 1e-2 -atol 1e-6 -rtol pressure:1e-5 -atol pressure:1e-5"

fieldcompare versions

The following table maps the versions of this action to the fieldcompare version it uses under the hood:

Action version	fieldcompare version
1.0.0	0.1.0
1.1.0	0.1.3
1.1.1	0.1.3
1.1.2	0.1.3
1.1.3	0.2.2