diff-action's Introduction

diff-action

Github Action to compare 2 files using diff 🕵️

🖥 Supported OS

OS	SUPPORTED
LINUX	YES
MACOS	YES
WINDOWS	YES

📚 How to use this action?

The actions/checkout is mandatory to use this action, as it will need to access the repository files.

Field	Mandatory	Observation
first_file_path	YES	ex: `path/to/file1.txt`
second_file_path	YES	ex: `path/to/file2.txt`
expected_result	NO	`PASSED` (default) or `FAILED`
specific_line	NO	ex: `1` (integer value only)

Will return FAIL: If the diff output of the 2 files/lines is different than the expected_result input value.

Will return SUCCESS: If the diff output of the 2 files/lines is equal the expected_result input value.

🕵️📋 Comparing 2 files

Expecting files to be identicals

    steps:
      - uses: actions/[email protected]
      - uses: GuillaumeFalourd/diff-action@v1
        with:
          first_file_path: path/to/file1.txt
          second_file_path: path/to/file2.txt
          expected_result: PASSED

Expecting files to be differents

    steps:
      - uses: actions/[email protected]
      - uses: GuillaumeFalourd/diff-action@v1
        with:
          first_file_path: path/to/file1.txt
          second_file_path: path/to/file2.txt
          expected_result: FAILED

🕵📝 Comparing 2 lines

Expecting lines to be identicals

    steps:
      - uses: actions/[email protected]
      - uses: GuillaumeFalourd/diff-action@v1
        with:
          first_file_path: path/to/file1.txt
          second_file_path: path/to/file2.txt
          specific_line: 3
          expected_result: PASSED

Expecting lines to be differents

    steps:
      - uses: actions/[email protected]
      - uses: GuillaumeFalourd/diff-action@v1
        with:
          first_file_path: path/to/file1.txt
          second_file_path: path/to/file2.txt
          specific_line: 3
          expected_result: FAILED