https://github.com/louisbrunner/diff-action

GitHub Action that compares two files, add tolerances, send notifications, etc
https://github.com/louisbrunner/diff-action

actions ci diff github-actions

Last synced: 3 months ago
JSON representation

GitHub Action that compares two files, add tolerances, send notifications, etc

• Host: GitHub
• URL: https://github.com/louisbrunner/diff-action
• Owner: LouisBrunner
• License: mit
• Created: 2020-03-01T15:58:43.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-06-16T12:08:13.000Z (8 months ago)
• Last Synced: 2024-11-04T14:45:55.167Z (3 months ago)
• Topics: actions, ci, diff, github-actions
• Language: TypeScript
• Homepage:
• Size: 1020 KB
• Stars: 8
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GitHub Actions: `diff-action` ![build-test](https://github.com/LouisBrunner/diff-action/workflows/build-test/badge.svg)

This GitHub Action allows you to compare two files based on a tolerance, output the result to a file and send various notifications (comment on a linked GitHub issue/pull request, create a [Check Run](https://developer.github.com/v3/checks/runs/#create-a-check-run), ...), etc.

## Usage

The following shows how to compare two files, making sure only additions happened, and output the difference to a file.

```

name: "build-test"

on: [push]

jobs:

  test_something:

    runs-on: ubuntu-latest

    steps:

    - uses: actions/checkout@v1

    - name: Check that the files are the exact same

      uses: LouisBrunner/[email protected]

      with:

        old: file1.txt

        new: file2.txt

        mode: strict

        tolerance: same

        output: out1.txt

    - name: Check that there are only additions in file2.txt

      uses: LouisBrunner/[email protected]

      with:

        old: file1.txt

        new: file2.txt

        mode: addition

        tolerance: better

        output: out2.txt

```

See the [examples workflow](.github/workflows/examples.yml) for more details and examples (and see the [associated runs](https://github.com/LouisBrunner/diff-action/actions?query=workflow%3Aexamples) to see how it will look like).

## Inputs

### `old`

**Required** The first file to compare

### `new`

**Required** The second file to compare

### `mode`

_Optional_ The method used to measure the `tolerance`, can be either:

* `strict` (default): the files must be exactly the same, only `tolerance: same` is allowed (which is the default)

* `addition`: addition are better

* `deletion`: deletion are better

### `tolerance`

_Optional_ The tolerance to check the diff for, depends on `mode`, can be either (examples given with mode = `deletion`) `better` (only deletion), `mixed-better` (more deletion than addition), `same` (stay the exact same), `mixed` (same amount of lines but not the same), `mixed-worse` (more addition than deletion) or `worse` (only addition)

Default is `same`

### `output`

_Optional_ The path where to output the diff (as well as on the console)

### `token`

_Optional_ Your `GITHUB_TOKEN`, **required** when using `notify_check` and/or `notify_issue`

### `title`

_Optional_ add a title to the notifications to distinguish between multiple workflows/jobs

### `notify_check`

_Optional_ Will create a [GitHub Check Run](https://developer.github.com/v3/checks/runs/#create-a-check-run) if `'true'` is specified, **requires** `token` to be given as well

### `notify_issue`

_Optional_ Will create a comment in the linked issue if `'true'` is specified, **requires** `token` to be given as well

## Outputs

### `passed`

Contains a boolean (`'true'` or `'false'`) representing if the check passed or not

### `output`

Contains the output of the diff