CHANGELOG.md

Changelog

v6.0.2

• Fix tag handling: preserve annotations and explicit fetch-tags by @ericsciple in #2356

v6.0.1

• Add worktree support for persist-credentials includeIf by @ericsciple in #2327

v6.0.0

• Persist creds to a separate file by @ericsciple in #2286
• Update README to include Node.js 24 support details and requirements by @salmanmkc in #2248

v5.0.1

• Port v6 cleanup to v5 by @ericsciple in #2301

v5.0.0

• Update actions checkout to use node 24 by @salmanmkc in #2226

v4.3.1

• Port v6 cleanup to v4 by @ericsciple in #2305

v4.3.0

• docs: update README.md by @motss in #1971
• Add internal repos for checking out multiple repositories by @mouismail in #1977
• Documentation update - add recommended permissions to Readme by @benwells in #2043
• Adjust positioning of user email note and permissions heading by @joshmgross in #2044
• Update README.md by @nebuk89 in #2194
• Update CODEOWNERS for actions by @TingluoHuang in #2224
• Update package dependencies by @salmanmkc in #2236

v4.2.2

• url-helper.ts now leverages well-known environment variables by @jww3 in #1941
• Expand unit test coverage for isGhes by @jww3 in #1946

v4.2.1

• Check out other refs/* by commit if provided, fall back to ref by @orhantoy in #1924

v4.2.0

• Add Ref and Commit outputs by @lucacome in #1180
• Dependency updates by @dependabot- #1777, #1872

v4.1.7

• Bump the minor-npm-dependencies group across 1 directory with 4 updates by @dependabot in #1739
• Bump actions/checkout from 3 to 4 by @dependabot in #1697
• Check out other refs/* by commit by @orhantoy in #1774
• Pin actions/checkout's own workflows to a known, good, stable version. by @jww3 in #1776

v4.1.6

• Check platform to set archive extension appropriately by @cory-miller in #1732

v4.1.5

• Update NPM dependencies by @cory-miller in #1703
• Bump github/codeql-action from 2 to 3 by @dependabot in #1694
• Bump actions/setup-node from 1 to 4 by @dependabot in #1696
• Bump actions/upload-artifact from 2 to 4 by @dependabot in #1695
• README: Suggest user.email to be 41898282+github-actions[bot]@users.noreply.github.com by @cory-miller in #1707

v4.1.4

• Disable extensions.worktreeConfig when disabling sparse-checkout by @jww3 in #1692
• Add dependabot config by @cory-miller in #1688
• Bump the minor-actions-dependencies group with 2 updates by @dependabot in #1693
• Bump word-wrap from 1.2.3 to 1.2.5 by @dependabot in #1643

v4.1.3

• Check git version before attempting to disable sparse-checkout by @jww3 in #1656
• Add SSH user parameter by @cory-miller in #1685
• Update actions/checkout version in update-main-version.yml by @jww3 in #1650

v4.1.2

• Fix: Disable sparse checkout whenever sparse-checkout option is not present @dscho in #1598

v4.1.1

• Correct link to GitHub Docs by @peterbe in #1511
• Link to release page from what's new section by @cory-miller in #1514

v4.1.0

• Add support for partial checkout filters

v4.0.0

• Support fetching without the --progress option
• Update to node20

v3.6.0

• Fix: Mark test scripts with Bash'isms to be run via Bash
• Add option to fetch tags even if fetch-depth > 0

v3.5.3

• Fix: Checkout fail in self-hosted runners when faulty submodule are checked-in
• Fix typos found by codespell
• Add support for sparse checkouts

v3.5.2

• Fix api endpoint for GHES

v3.5.1

• Fix slow checkout on Windows

v3.5.0

• Add new public key for known_hosts

v3.4.0

• Upgrade codeql actions to v2
• Upgrade dependencies
• Upgrade @actions/io

v3.3.0

• Implement branch list using callbacks from exec function
• Add in explicit reference to private checkout options
• Fix comment typos (that got added in #770)

v3.2.0

• Add GitHub Action to perform release
• Fix status badge
• Replace datadog/squid with ubuntu/squid Docker image
• Wrap pipeline commands for submoduleForeach in quotes
• Update @actions/io to 1.1.2
• Upgrading version to 3.2.0

v3.1.0

• Use @actions/core saveState and getState
• Add github-server-url input

v3.0.2

• Add input set-safe-directory

v3.0.1

• Fixed an issue where checkout failed to run in container jobs due to the new git setting safe.directory
• Bumped various npm package versions

v3.0.0

• Update to node 16

v2.3.1

• Fix default branch resolution for .wiki and when using SSH

v2.3.0

• Fallback to the default branch

v2.2.0

• Fetch all history for all tags and branches when fetch-depth=0

v2.1.1

• Changes to support GHES (here and here)

v2.1.0

• Group output
• Changes to support GHES alpha release
• Persist core.sshCommand for submodules
• Add support ssh
• Convert submodule SSH URL to HTTPS, when not using SSH
• Add submodule support
• Follow proxy settings
• Fix ref for pr closed event when a pr is merged
• Fix issue checking detached when git less than 2.22

v2.0.0

• Do not pass cred on command line
• Add input persist-credentials
• Fallback to REST API to download repo

v2 (beta)

• Improved fetch performance
  • The default behavior now fetches only the SHA being checked-out
• Script authenticated git commands
  • Persists with.token in the local git config
  • Enables your scripts to run authenticated git commands
  • Post-job cleanup removes the token
  • Coming soon: Opt out by setting with.persist-credentials to false
• Creates a local branch
  • No longer detached HEAD when checking out a branch
  • A local branch is created with the corresponding upstream branch set
• Improved layout
  • with.path is always relative to github.workspace
  • Aligns better with container actions, where github.workspace gets mapped in
• Removed input submodules

v1

Refer here for the V1 changelog