Initial implementation of logDiffIfDirty

README.md

@@ -359,6 +359,24 @@ Note that it is generally bad practice to modify your branch
 in a CI Pipeline. However there are exceptions where this might
 be needed. (use with care).
 
+_**required:** `false`_
+_**default:** false_
+
+#### logDiffIfDirty
+
+Print a summary of changed files if the branch is determined to be dirty.
+This can be useful in debugging the reason your project files changed unexpectedly.
+This option works independently of `allowDirtyBuild`.
+
+```yaml
+- uses: webbertakken/unity-builder@<version>
+  with:
+    logDiffIfDirty: true
+```
+
+_**required:** `false`_
+_**default:** false_
+
 #### customParameters
 
 Custom parameters to configure the build.

action.yml

@@ -70,6 +70,23 @@ inputs:
 
       Parameters must start with a hyphen (-) and may be followed by a value (without hyphen).
       Parameters without a value will be considered booleans (with a value of true).
+  allowDirtyBuild:
+    required: false
+    default: ''
+    description: >
+      Allows the branch of the build to be dirty, and still generate the build.
+
+      Note that it is generally bad practice to modify your branch
+      in a CI Pipeline. However there are exceptions where this might
+      be needed. (use with care).
+  logDiffIfDirty:
+    required: false
+    default: ''
+    description: >
+      Print a summary of changed files if the branch is determined to be dirty.
+
+      This can be useful in debugging the reason your project files changed unexpectedly.
+      This option works independently of allowDirtyBuild.
 outputs: {}
 branding:
   icon: 'box'

src/model/input.js

@@ -77,6 +77,12 @@ class Input {
     return input === 'true' ? 'true' : 'false';
   }
 
+  static get logDiffIfDirty() {
+    const input = core.getInput('logDiffIfDirty') || 'false';
+
+    return input === 'true' ? 'true' : 'false';
+  }
+
   static get customParameters() {
     return core.getInput('customParameters') || '';
   }

src/model/input.test.js

@@ -232,6 +232,24 @@ describe('Input', () => {
     });
   });
 
+  describe('logDiffIfDirty', () => {
+    it('returns the default value', () => {
+      expect(Input.logDiffIfDirty).toStrictEqual('false');
+    });
+
+    it('returns true when string true is passed', () => {
+      const spy = jest.spyOn(core, 'getInput').mockReturnValue('true');
+      expect(Input.logDiffIfDirty).toStrictEqual('true');
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+
+    it('returns false when string false is passed', () => {
+      const spy = jest.spyOn(core, 'getInput').mockReturnValue('false');
+      expect(Input.logDiffIfDirty).toStrictEqual('false');
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+  });
+
   describe('customParameters', () => {
     it('returns the default value', () => {
       expect(Input.customParameters).toStrictEqual('');

src/model/versioning.js

@@ -13,6 +13,10 @@ export default class Versioning {
     return Input.allowDirtyBuild === 'true';
   }
 
+  static get logDiffIfDirty() {
+    return Input.logDiffIfDirty === 'true';
+  }
+
   static get strategies() {
     return { None: 'None', Semantic: 'Semantic', Tag: 'Tag', Custom: 'Custom' };
   }
@@ -178,7 +182,12 @@ export default class Versioning {
   static async isDirty() {
     const output = await this.git(['status', '--porcelain']);
 
-    return output !== '';
+    const dirty = output !== '';
+    if (dirty && this.logDiffIfDirty) {
+      await this.git(['--no-pager', 'diff']);
+    }
+
+    return dirty;
   }
 
   /**