update readme/changelog for v6 (#2311)

CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
+## V6.0.0
+* Persist creds to a separate file by @ericsciple in https://github.com/actions/checkout/pull/2286
+* Update README to include Node.js 24 support details and requirements by @salmanmkc in https://github.com/actions/checkout/pull/2248
+
+## V5.0.1
+* Port v6 cleanup to v5 by @ericsciple in https://github.com/actions/checkout/pull/2301
+
 ## V5.0.0
 * Update actions checkout to use node 24 by @salmanmkc in https://github.com/actions/checkout/pull/2226
 
+## V4.3.1
+* Port v6 cleanup to v4 by @ericsciple in https://github.com/actions/checkout/pull/2305
 
 ## V4.3.0
 * docs: update README.md by @motss in https://github.com/actions/checkout/pull/1971

README.md

@@ -1,6 +1,6 @@
 [![Build and Test](https://github.com/actions/checkout/actions/workflows/test.yml/badge.svg)](https://github.com/actions/checkout/actions/workflows/test.yml)
 
-# Checkout v6-beta
+# Checkout v6
 
 ## What's new
 
@@ -62,11 +62,6 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
     # Otherwise, uses the default branch.
     ref: ''
 
-    # The commit SHA to checkout. Used when ref is not specified or is ambiguous. This
-    # can be used as a replacement for ref, or alongside it to checkout a specific
-    # commit of the ref.
-    commit: ''
-
     # Personal access token (PAT) used to fetch the repository. The PAT is configured
     # with the local git config, which enables your scripts to run authenticated git
     # commands. The post-job step removes the PAT.

__test__/input-helper.test.ts

@@ -144,30 +144,4 @@ describe('input-helper tests', () => {
     const settings: IGitSourceSettings = await inputHelper.getInputs()
     expect(settings.workflowOrganizationId).toBe(123456)
   })
-
-  it('accepts ref and commit', async () => {
-    inputs.ref = 'refs/pull/123/merge'
-    inputs.commit = '0123456789012345678901234567890123456789'
-    const settings: IGitSourceSettings = await inputHelper.getInputs()
-    expect(settings).toBeTruthy()
-    expect(settings.ref).toBeTruthy()
-    expect(settings.ref).toStrictEqual('refs/pull/123/merge')
-    expect(settings.commit).toBeTruthy()
-    expect(settings.commit).toStrictEqual(
-      '0123456789012345678901234567890123456789'
-    )
-  })
-
-  it('ref fallbacks to commit if ref is empty but commit is specified', async () => {
-    inputs.ref = ''
-    inputs.commit = '0123456789012345678901234567890123456789'
-    const settings: IGitSourceSettings = await inputHelper.getInputs()
-    expect(settings).toBeTruthy()
-    expect(settings.ref).toBeFalsy()
-    expect(settings.ref).toStrictEqual('')
-    expect(settings.commit).toBeTruthy()
-    expect(settings.commit).toStrictEqual(
-      '0123456789012345678901234567890123456789'
-    )
-  })
 })

action.yml

@@ -9,11 +9,6 @@ inputs:
       The branch, tag or SHA to checkout. When checking out the repository that
       triggered a workflow, this defaults to the reference or SHA for that
       event.  Otherwise, uses the default branch.
-  commit:
-    description: >
-      The commit SHA to checkout. Used when ref is not specified or is ambiguous.
-      This can be used as a replacement for ref, or alongside it to checkout a
-      specific commit of the ref.
   token:
     description: >
       Personal access token (PAT) used to fetch the repository. The PAT is configured

dist/index.js

@@ -1980,11 +1980,7 @@ function getInputs() {
         const isWorkflowRepository = qualifiedRepository.toUpperCase() ===
             `${github.context.repo.owner}/${github.context.repo.repo}`.toUpperCase();
         // Source branch, source version
-        result.commit = core.getInput('commit');
+        result.ref = core.getInput('ref');
-        if (result.commit && !result.commit.match(/^[0-9a-fA-F]{40}$/)) {
-            throw new Error(`The commit SHA '${result.commit}' is not a valid SHA.`);
-        }
-        result.ref = core.getInput('ref') || result.commit;
         if (!result.ref) {
             if (isWorkflowRepository) {
                 result.ref = github.context.ref;

src/input-helper.ts

@@ -57,12 +57,7 @@ export async function getInputs(): Promise<IGitSourceSettings> {
     `${github.context.repo.owner}/${github.context.repo.repo}`.toUpperCase()
 
   // Source branch, source version
-  result.commit = core.getInput('commit')
+  result.ref = core.getInput('ref')
-  if (result.commit && !result.commit.match(/^[0-9a-fA-F]{40}$/)) {
-    throw new Error(`The commit SHA '${result.commit}' is not a valid SHA.`)
-  }
-
-  result.ref = core.getInput('ref') || result.commit
   if (!result.ref) {
     if (isWorkflowRepository) {
       result.ref = github.context.ref