Merge 3c3e99848b36c587c8046383ab04e86713061576 into de5a000abf73b6f4965bd1bcdf8f8d94a56ea815

Check out other refs/* by commit if provided, fall back to ref (#1924 )
Document that filter doesn't override fetch-depth
2025-06-11 12:42:41 +08:00 · 2024-10-01 21:50:10 -07:00 · 2024-10-01 20:24:28 -04:00 · 2023-10-05 09:04:25 -07:00
5 changed files with 19 additions and 6 deletions
--- a/README.md
+++ b/README.md
@ -79,6 +79,8 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
    clean: ''

    # Partially clone against a given filter. Overrides sparse-checkout if set.
+    # Note that when a filter is provided, fetch-depth is still respected; you
+    # may want to specify `fetch-depth: 0` to ensure the full history is fetched.
    # Default: null
    filter: ''

--- a/test/ref-helper.test.ts
+++ b/test/ref-helper.test.ts
@ -77,6 +77,16 @@ describe('ref-helper tests', () => {
    expect(checkoutInfo.startPoint).toBeFalsy()
  })

+  it('getCheckoutInfo refs/ without commit', async () => {
+    const checkoutInfo = await refHelper.getCheckoutInfo(
+      git,
+      'refs/non-standard-ref',
+      ''
+    )
+    expect(checkoutInfo.ref).toBe('refs/non-standard-ref')
+    expect(checkoutInfo.startPoint).toBeFalsy()
+  })
+
  it('getCheckoutInfo unqualified branch only', async () => {
    git.branchExists = jest.fn(async (remote: boolean, pattern: string) => {
      return true
--- a/action.yml
+++ b/action.yml
@ -59,8 +59,9 @@ inputs:
    default: true
  filter:
    description: >
-      Partially clone against a given filter.
-      Overrides sparse-checkout if set.
+      Partially clone against a given filter. Overrides sparse-checkout if set.
+      Note that when a filter is provided, fetch-depth is still respected; you
+      may want to specify `fetch-depth: 0` to ensure the full history is fetched.
    default: null
  sparse-checkout:
    description: >
--- a/dist/index.js
+++ b/dist/index.js
@ -2005,8 +2005,8 @@ function getCheckoutInfo(git, ref, commit) {
            result.ref = ref;
        }
        // refs/
-        else if (upperRef.startsWith('REFS/') && commit) {
-            result.ref = commit;
+        else if (upperRef.startsWith('REFS/')) {
+            result.ref = commit ? commit : ref;
        }
        // Unqualified ref, check for a matching branch or tag
        else {
--- a/src/ref-helper.ts
+++ b/src/ref-helper.ts
@ -46,8 +46,8 @@ export async function getCheckoutInfo(
    result.ref = ref
  }
  // refs/
-  else if (upperRef.startsWith('REFS/') && commit) {
-    result.ref = commit
+  else if (upperRef.startsWith('REFS/')) {
+    result.ref = commit ? commit : ref
  }
  // Unqualified ref, check for a matching branch or tag
  else {
Author	SHA1	Message	Date
Jake Bailey	42feabf761	Merge 3c3e99848b36c587c8046383ab04e86713061576 into de5a000abf73b6f4965bd1bcdf8f8d94a56ea815	2024-10-01 21:50:10 -07:00
Orhan Toy	de5a000abf	Check out other refs/* by commit if provided, fall back to ref (#1924 ) Some checks failed Check dist / check-dist (push) Has been cancelled Details CodeQL / Analyze (javascript) (push) Has been cancelled Details Licensed / Check licenses (push) Has been cancelled Details Build and Test / build (push) Has been cancelled Details Build and Test / test (macos-latest) (push) Has been cancelled Details Build and Test / test (ubuntu-latest) (push) Has been cancelled Details Build and Test / test (windows-latest) (push) Has been cancelled Details Build and Test / test-proxy (push) Has been cancelled Details Build and Test / test-bypass-proxy (push) Has been cancelled Details Build and Test / test-git-container (push) Has been cancelled Details Build and Test / test-output (push) Has been cancelled Details	2024-10-01 20:24:28 -04:00
Jake Bailey	3c3e99848b	Document that filter doesn't override fetch-depth	2023-10-05 09:04:25 -07:00