feat: input to force update for an existing ref

Author: dsanders11

.github/workflows/integration-tests.yml

@@ -23,6 +23,10 @@ jobs:
         id: checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
 
+      - name: Make note of the branch name
+        id: branch-name
+        run: echo "BRANCH=$(git rev-parse --abbrev-ref HEAD)" >> "$GITHUB_OUTPUT"
+
       - name: Generate GitHub App Token
         uses: electron/github-app-auth-action@384fd19694fe7b6dcc9a684746c6976ad78228ae # v1.1.1
         id: generate-token
@@ -154,6 +158,7 @@ jobs:
         run: |
           git pull
           git clean -fdx
+          git restore .
 
       - name: Optionally don't fail if no changes to commit
         uses: ./
@@ -163,9 +168,48 @@ jobs:
           ref: integration-test-playground-${{ github.run_id }}-${{ github.run_number }}
           token: ${{ steps.generate-token.outputs.token }}
 
+      - name: Switch back to base branch
+        run: git switch ${{ steps.branch-name.outputs.BRANCH }}
+
+      - name: Make changes to commit and stage them
+        run: |
+          date +%s%3N > current-date.txt
+          git add current-date.txt
+
+      - name: Update existing ref (force)
+        uses: ./
+        id: force-update-existing-ref
+        with:
+          force: true
+          message: Test updating existing ref (force)
+          ref: integration-test-playground-${{ github.run_id }}-${{ github.run_number }}
+          token: ${{ steps.generate-token.outputs.token }}
+
+      - name: Confirm forced commit
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{ steps.generate-token.outputs.token }}
+          script: |
+            const assert = require('node:assert');
+
+            const refs = ['integration-test-playground-${{ github.run_id }}-${{ github.run_number }}', '${{ steps.force-update-existing-ref.outputs.sha }}'];
+
+            // Fetch the commit by both ref and sha
+            for (const ref of refs) {
+              const { data } = await github.rest.repos.getCommit({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                ref: 'integration-test-playground-${{ github.run_id }}-${{ github.run_number }}',
+              });
+
+              assert.strictEqual(data.sha, '${{ steps.force-update-existing-ref.outputs.sha }}', 'Expected sha for commit to match');
+              assert.strictEqual(data.commit.message, 'Test updating existing ref (force)', 'Expected commit message to match');
+              assert.strictEqual(data.commit.verification.verified, true, 'Expected commit to be verified');
+            }
+
       - name: Clean up new ref
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
-        if: ${{ steps.generate-token.outputs.token }}
+        if: ${{ always() && steps.generate-token.outputs.token }}
         with:
           github-token: ${{ steps.generate-token.outputs.token }}
           script: |

README.md

@@ -23,7 +23,8 @@ instead of running `git commit`. The changes to commit will be detected automati
 ### Updating Existing Ref
 
 If you want to update an existing ref, you should ensure that ref is checked out in
-the current git checkout (you can use the `ref` input for `actions/checkout`).
+the current git checkout (you can use the `ref` input for `actions/checkout`). You
+can force the update using the `force` input.
 
 ### Multiple Commits
 
@@ -60,6 +61,7 @@ jobs:
 ### Inputs
 
 - `fail-on-no-changes` - *(optional)* Whether or not to set action failure if there are no changes to commit (default: `true`)
+- `force` - *(optional)* Whether to force the update or to make sure the update is a fast-forward update when updating an existing ref (default: `false`)
 - `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

@@ -97,6 +97,7 @@ describe('action', () => {
     const headTreeHash = 'head-tree-hash';
 
     mockGetInput({ message, token });
+    mockGetBooleanInput({});
     jest.mocked(lib.getHeadRef).mockResolvedValue(ref);
     jest.mocked(lib.getHeadSha).mockResolvedValue('head-sha');
     jest.mocked(lib.getHeadTreeHash).mockResolvedValue(headTreeHash);
@@ -123,7 +124,8 @@ describe('action', () => {
     expect(updateRef).toHaveBeenCalledWith(
       expect.objectContaining({
         sha: commitSha,
-        ref: `heads/${ref}`
+        ref: `heads/${ref}`,
+        force: false
       })
     );
 
@@ -137,6 +139,7 @@ describe('action', () => {
     const headTreeHash = 'head-tree-hash';
 
     mockGetInput({ message, token, ref });
+    mockGetBooleanInput({});
     jest.mocked(lib.getHeadSha).mockResolvedValue('head-sha');
     jest.mocked(lib.getHeadTreeHash).mockResolvedValue(headTreeHash);
     jest.mocked(lib.getStagedFiles).mockResolvedValue(stagedFiles);
@@ -162,7 +165,8 @@ describe('action', () => {
     expect(updateRef).toHaveBeenCalledWith(
       expect.objectContaining({
         sha: commitSha,
-        ref: `heads/${ref}`
+        ref: `heads/${ref}`,
+        force: false
       })
     );
 
@@ -218,7 +222,8 @@ describe('action', () => {
     expect(updateRef).toHaveBeenCalledWith(
       expect.objectContaining({
         sha: commitSha,
-        ref: `heads/${ref}`
+        ref: `heads/${ref}`,
+        force: false
       })
     );
     expect(createRef).toHaveBeenCalledWith(
@@ -282,6 +287,32 @@ describe('action', () => {
     );
   });
 
+  it('can force an update', async () => {
+    const ref = 'main';
+    const commitSha = 'commit-sha';
+
+    mockGetInput({ message, token });
+    mockGetBooleanInput({ force: true });
+    jest.mocked(lib.getHeadRef).mockResolvedValue(ref);
+    jest.mocked(lib.getHeadSha).mockResolvedValue('head-sha');
+    jest.mocked(lib.getHeadTreeHash).mockResolvedValue('head-tree-hash');
+    jest.mocked(lib.getStagedFiles).mockResolvedValue(stagedFiles);
+    jest.mocked(createTree).mockResolvedValue({ data: { sha: 'tree-sha' } });
+    jest.mocked(createCommit).mockResolvedValue({ data: { sha: commitSha } });
+    jest.mocked(updateRef).mockResolvedValue({ data: {} });
+
+    await main.run();
+    expect(runSpy).toHaveReturned();
+
+    expect(lib.getHeadRef).toHaveBeenCalled();
+    expect(updateRef).toHaveBeenCalledWith(
+      expect.objectContaining({
+        force: true
+      })
+    );
+    expect(createRef).not.toHaveBeenCalled();
+  });
+
   it('handles generic errors', async () => {
     mockGetInput({ message, token });
     jest.mocked(lib.getStagedFiles).mockImplementation(() => {

action.yml

@@ -11,6 +11,10 @@ inputs:
     description: Whether or not to set action failure if there are no changes to commit
     required: false
     default: true
+  force:
+    description: Whether to force the update or to make sure the update is a fast-forward update when updating an existing ref
+    required: false
+    default: false
   message:
     description: The commit message
     required: true

dist/index.js

@@ -67,6 +67,7 @@ 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 force = core.getBooleanInput('force');
 
     const tree = await populateTree();
 
@@ -105,7 +106,8 @@ export async function run(): Promise<void> {
         owner,
         repo,
         ref,
-        sha: newCommit.data.sha
+        sha: newCommit.data.sha,
+        force
       });
       core.debug(`Updated ref: ${ref} to ${newCommit.data.sha}`);
     } catch (err) {