Add mode, finish processing

Author: LouisBrunner

.github/workflows/examples.yml

@@ -4,70 +4,138 @@ on: [push]
 jobs:
   # make sure the action works on a clean machines without building
 
-  ## Basic
-  test_basic_less:
+  ## Additions
+  test_additions_deleted:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file2_less.txt
+        new: fixtures/file2_deleted.txt
+        mode: addition
 
-  test_basic_same:
+  test_additions_same:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
         new: fixtures/file3_same.txt
+        mode: addition
 
-  test_basic_more:
+  test_additions_added:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file4_more.txt
+        new: fixtures/file4_added.txt
+        mode: addition
 
-  test_basic_mixed:
+  test_additions_mixed:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
         new: fixtures/file5_mixed.txt
+        mode: addition
 
-  test_basic_mixed_better:
+  test_additions_mixed_added:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file6_mixed_better.txt
+        new: fixtures/file6_mixed_added.txt
+        mode: addition
 
-  test_basic_mixed_worse:
+  test_additions_mixed_deleted:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file7_mixed_worse.txt
+        new: fixtures/file7_mixed_deleted.txt
+        mode: addition
 
-  # Tolerance
-  test_tolerance_less:
+  ## Deletions
+  test_deletions_deleted:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file2_less.txt
+        new: fixtures/file2_deleted.txt
+        mode: deletion
+
+  test_deletions_same:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ./
+      with:
+        old: fixtures/file1_basic.txt
+        new: fixtures/file3_same.txt
+        mode: deletion
+
+  test_deletions_added:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ./
+      with:
+        old: fixtures/file1_basic.txt
+        new: fixtures/file4_added.txt
+        mode: deletion
+
+  test_deletions_mixed:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ./
+      with:
+        old: fixtures/file1_basic.txt
+        new: fixtures/file5_mixed.txt
+        mode: deletion
+
+  test_deletions_mixed_added:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ./
+      with:
+        old: fixtures/file1_basic.txt
+        new: fixtures/file6_mixed_added.txt
+        mode: deletion
+
+  test_deletions_mixed_deleted:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ./
+      with:
+        old: fixtures/file1_basic.txt
+        new: fixtures/file7_mixed_deleted.txt
+        mode: deletion
+
+  # Tolerance (Additions)
+  test_tolerance_deleted:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ./
+      with:
+        old: fixtures/file1_basic.txt
+        new: fixtures/file2_deleted.txt
+        mode: addition
         tolerance: worse
 
   test_tolerance_same:
@@ -78,16 +146,18 @@ jobs:
       with:
         old: fixtures/file1_basic.txt
         new: fixtures/file3_same.txt
+        mode: addition
         tolerance: same
 
-  test_tolerance_more:
+  test_tolerance_added:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file4_more.txt
+        new: fixtures/file4_added.txt
+        mode: addition
         tolerance: better
 
   test_tolerance_mixed:
@@ -98,26 +168,29 @@ jobs:
       with:
         old: fixtures/file1_basic.txt
         new: fixtures/file5_mixed.txt
+        mode: addition
         tolerance: mixed
 
-  test_tolerance_mixed_better:
+  test_tolerance_mixed_added:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file6_mixed_better.txt
+        new: fixtures/file6_mixed_added.txt
+        mode: addition
         tolerance: mixed-better
 
-  test_tolerance_mixed_worse:
+  test_tolerance_mixed_deleted:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v1
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file7_mixed_worse.txt
+        new: fixtures/file7_mixed_deleted.txt
+        mode: addition
         tolerance: mixed-worse
 
   # Outputs
@@ -128,7 +201,8 @@ jobs:
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file4_more.txt
+        new: fixtures/file4_added.txt
+        mode: addition
         output: out.txt
     - run: cat out.txt
 
@@ -139,7 +213,8 @@ jobs:
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file4_more.txt
+        new: fixtures/file4_added.txt
+        mode: addition
         token: ${{ secrets.GITHUB }}
         notify_issue: true
         notify_check: true
@@ -151,7 +226,8 @@ jobs:
     - uses: ./
       with:
         old: fixtures/file1_basic.txt
-        new: fixtures/file2_less.txt
+        new: fixtures/file2_deleted.txt
+        mode: addition
         token: ${{ secrets.GITHUB }}
         notify_issue: true
         notify_check: true

README.md

@@ -4,7 +4,7 @@ This GitHub Action allows you to compare two files based on a tolerance, output
 
 ## Usage
 
-The following shows how to compare two files and output the difference to a file.
+The following shows how to compare two files, making sure only additions happened, and output the difference to a file.
 
 ```
 name: "build-test"
@@ -19,6 +19,7 @@ jobs:
       with:
         old: file1.txt
         new: file2.txt
+        mode: addition
         tolerance: better
         output: out.txt
 ```
@@ -35,9 +36,13 @@ See the [examples workflow](.github/workflows/examples.yml) for more details and
 
 **Required** The second file to compare
 
+### `mode`
+
+**Required** The method used to measure the `tolerance`, can be either `addition` (addition are better) or `deletion` (deletion are better)
+
 ### `tolerance`
 
-**Required** The tolerance to check the diff for, can be either `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)
+**Required** 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)
 
 ### `output`
 

__tests__/main.test.ts

@@ -5,8 +5,9 @@ import * as path from 'path';
 // shows how the runner will run a javascript action with env / stdout protocol
 test('test runs', () => {
   process.env['INPUT_OLD'] = path.join(__dirname, '..', 'fixtures', 'file1_basic.txt');
-  process.env['INPUT_NEW'] = path.join(__dirname, '..', 'fixtures', 'file4_more.txt');
+  process.env['INPUT_NEW'] = path.join(__dirname, '..', 'fixtures', 'file4_added.txt');
   process.env['INPUT_TOLERANCE'] = 'better';
+  process.env['INPUT_MODE'] = 'addition';
   const ip = path.join(__dirname, '..', 'lib', 'main.js');
   const options: cp.ExecSyncOptions = {
     env: process.env,

action.yml

@@ -11,6 +11,9 @@ inputs:
   new:
     description: 'second file to compare'
     required: true
+  mode:
+    description: 'the mode used to measure the tolerance'
+    required: true
   tolerance:
     description: 'the tolerance used to judge if the diff improved'
     required: false