feat: option to not fail when no changes to commit

Author: dsanders11

.github/workflows/integration-tests.yml

@@ -150,6 +150,19 @@ jobs:
               assert.strictEqual(data.commit.verification.verified, true, 'Expected commit to be verified');
             }
 
+      - name: Update checkout
+        run: |
+          git pull
+          git clean -fdx
+
+      - name: Optionally don't fail if no changes to commit
+        uses: ./
+        with:
+          fail-on-no-changes: false
+          message: Nothing to commit
+          ref: integration-test-playground-${{ github.run_id }}-${{ github.run_number }}
+          token: ${{ steps.generate-token.outputs.token }}
+
       - name: Clean up new ref
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         if: ${{ steps.generate-token.outputs.token }}

README.md

@@ -59,6 +59,7 @@ jobs:
 
 ### Inputs
 
+- `fail-on-no-changes` - *(optional)* Whether or not to set action failure if there are no changes to commit (default: `true`)
 - `message` - **(required)** The commit message
 - `ref` - *(optional)* Git reference to associate the commit with (e.g. `main`). If it does not exist it will be created. Defaults to the the current checkout ref.
 - `token` - **(required)** GitHub App installation access token

__tests__/main.test.ts

@@ -5,7 +5,7 @@ import { RequestError } from '@octokit/request-error';
 
 import * as lib from '../src/lib';
 import * as main from '../src/main';
-import { mockGetInput } from './utils';
+import { mockGetBooleanInput, mockGetInput } from './utils';
 
 const createCommit = jest.fn();
 const createRef = jest.fn();
@@ -255,6 +255,7 @@ describe('action', () => {
 
   it('errors if no changes to commit', async () => {
     mockGetInput({ message, token });
+    mockGetBooleanInput({ 'fail-on-no-changes': true });
     jest.mocked(lib.getStagedFiles).mockResolvedValue([]);
 
     await main.run();
@@ -266,6 +267,21 @@ describe('action', () => {
     );
   });
 
+  it('does not error if fail-on-no-changes is false', async () => {
+    mockGetInput({ message, token });
+    mockGetBooleanInput({ 'fail-on-no-changes': false });
+    jest.mocked(lib.getStagedFiles).mockResolvedValue([]);
+
+    await main.run();
+    expect(runSpy).toHaveReturned();
+
+    expect(core.setFailed).not.toHaveBeenCalled();
+    expect(core.notice).toHaveBeenCalledTimes(1);
+    expect(core.notice).toHaveBeenLastCalledWith(
+      'No changes found to commit - skipping'
+    );
+  });
+
   it('handles generic errors', async () => {
     mockGetInput({ message, token });
     jest.mocked(lib.getStagedFiles).mockImplementation(() => {

__tests__/utils.ts

@@ -22,3 +22,9 @@ export function mockGetInput(inputs: Record<string, string>): void {
     .mocked(core.getInput)
     .mockImplementation(makeMockInputImplementation(inputs, ''));
 }
+
+export function mockGetBooleanInput(inputs: Record<string, boolean>): void {
+  jest
+    .mocked(core.getBooleanInput)
+    .mockImplementation(makeMockInputImplementation(inputs, false));
+}

action.yml

@@ -7,6 +7,10 @@ branding:
   color: green
 
 inputs:
+  fail-on-no-changes:
+    description: Whether or not to set action failure if there are no changes to commit
+    required: false
+    default: true
   message:
     description: The commit message
     required: true

dist/index.js

@@ -66,11 +66,16 @@ export async function run(): Promise<void> {
 
     // Optional inputs
     const ref = `heads/${core.getInput('ref') || (await getHeadRef())}`;
+    const failOnNoChanges = core.getBooleanInput('fail-on-no-changes');
 
     const tree = await populateTree();
 
     if (tree.length === 0) {
-      core.setFailed('No changes found to commit');
+      if (failOnNoChanges) {
+        core.setFailed('No changes found to commit');
+      } else {
+        core.notice('No changes found to commit - skipping');
+      }
       return;
     }