actions/checkout
Watch
1
0
Fork
You've already forked checkout
 0
mirror of https://code.forgejo.org/actions/checkout.git synced 2026-08-28 04:54:59 -04:00
Code Issues Projects Releases Packages Wiki Activity
216 commits 61 branches 68 tags 12 MiB
Commit graph checkout/README.md
Author SHA1 Message Date
Anatoly Rabkin
3ff67abc5a Fix timeout implementation and address review feedback 
- Kill git process on timeout: use child_process.spawn directly for
  timeout-eligible operations so we have a ChildProcess handle to send
  SIGTERM (then SIGKILL after 5s). On Windows, SIGTERM is a forced kill
  so the SIGKILL fallback is effectively a no-op there.

- Fix timeout:0 not working: replace falsy || coalescion with explicit
  empty-string check so that '0' is not replaced by the default '300'.

- Refactor execGit to use an options object instead of 5 positional
  parameters, eliminating error-prone filler args (false, false, {}).

- Pass allowAllExitCodes through to execGitWithTimeout so both code
  paths have consistent behavior for non-zero exit codes.

- Add settled guard to prevent double-reject when both close and error
  events fire on the spawned process.

- Handle null exit code (process killed by signal) as an error rather
  than silently treating it as success.

- Capture stderr in error messages for the timeout path, matching the
  information level of the non-timeout exec path.

- Log SIGKILL failures at debug level instead of empty catch block.

- Warn on customListeners being ignored in the timeout path.

- Emit core.warning() when invalid input values are silently replaced
  with defaults, so users know their configuration was rejected.

- Add input validation in setTimeout (reject negative values).

- Clarify retry-max-attempts semantics: total attempts including the
  initial attempt (3 = 1 initial + 2 retries).

- Remove Kubernetes probe references from descriptions.

- Use non-exhaustive list (e.g.) for network operations in docs to
  avoid staleness if new operations are added.

- Add tests for timeout/retry input parsing (defaults, timeout:0,
  custom values, invalid input with warnings, backoff clamping) and
  command manager configuration (setTimeout, setRetryConfig, fetch).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
 2026-03-18 23:52:14 +02:00
Anatoly Rabkin
5df58a66d1 Add configurable timeout and retry for git network operations 
Add per-attempt timeout (default 300s) and Kubernetes probe-style retry
configuration for git fetch, lfs-fetch, and ls-remote. New action inputs:
timeout, retry-max-attempts, retry-min-backoff, retry-max-backoff.

Fixes https://github.com/actions/checkout/issues/631

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
 2026-03-18 18:09:42 +02:00
eric sciple
8e8c483db8
 		Clarify v6 README (#2328) 2025-12-01 20:08:49 -06:00
eric sciple
c2d88d3ecc
 		Update all references from v5 and v4 to v6 (#2314) 
- Updated README.md examples to reference @v6
- Updated all workflow files to use actions/checkout@v6
 2025-11-23 19:32:55 -06:00
eric sciple
1af3b93b68
 		update readme/changelog for v6 (#2311) 2025-11-20 10:20:04 -06:00
eric sciple
71cf2267d8
 		v6-beta (#2298) 2025-11-03 13:40:10 -06:00
Salman Chishti
ff7abcd0c3
 		Update README to include Node.js 24 support details and requirements (#2248) 
* Update README to include Node.js 24 support details and requirements

* Update
 2025-08-13 13:57:25 +01:00
Salman Chishti
08c6903cd8
 		Prepare v5.0.0 release (#2238) 2025-08-11 13:35:28 +01:00
Ben De St Paer-Gotch
09d2acae67
 		Update README.md (#2194) 2025-06-06 09:19:16 +01:00
Josh Gross
85e6279cec
 		Adjust positioning of user email note and permissions heading (#2044) 2025-01-16 15:56:18 -05:00
Ben Wells
009b9ae9e4
 		Documentation update - add recommended permissions to Readme (#2043) 
* Update README.md

* Update README.md

Co-authored-by: Josh Gross <joshmgross@github.com>

---------

Co-authored-by: Josh Gross <joshmgross@github.com>
 2025-01-16 14:14:48 -05:00
Mohammad Ismail
cbb722410c
 		Update README.md (#1977) 2024-11-14 10:41:00 -05:00
The web walker
3b9b8c884f
 		docs: update README.md (#1971) 
Add a scenario where it is necessary to push a commit to a pull request.
 2024-11-08 10:32:54 -05:00
yasonk
2d7d9f7ff5
 		Provide explanation for where user email came from (#1869) 
* Provide explanation for where user email came from

* bringing back the newline
 2024-09-02 09:53:38 -04:00
Cory Miller
44c2b7a8a4
 		README: Suggest user.email to be 41898282+github-actions[bot]@users.noreply.github.com (#1707) 
* README: Set `user.email` to GitHub Actions Bot

* Update workflow to use proper bot GitHub Bot email

* Prefix `user.email` with `41898282+`

To match squash merge user, else showing as two different users, see: b0948d0da0

* Update README.md

---------

Co-authored-by: Pelle Wessman <pelle@kodfabrik.se>
 2024-04-30 11:50:54 -04:00
Cory Miller
1d96c772d1
 		Add SSH user parameter (#1685) 
* Add a configurable SSH user

* Update docs with param

* Indentation of readme

* formatting woes

* Update src/url-helper.ts

Co-authored-by: Josh Gross <joshmgross@github.com>

* Update action.yml

Co-authored-by: Josh Gross <joshmgross@github.com>

* Update genfiles

---------

Co-authored-by: Josh Gross <joshmgross@github.com>
 2024-04-18 15:29:55 -04:00
Cory Miller
b4ffde65f4
 		Link to release page from what's new section (#1514) 2023-10-17 11:52:30 -04:00
Peter Bengtsson
8530928916
 		Correct link to GitHub Docs (#1511) 
No hardcoded language in the URL and uses the correct docs.github.com domain.
 2023-10-13 11:07:47 -04:00
Finley Garton
c533a0a4cf
 		Add support for partial checkout filters (#1396) 
* added filter option & tests

* added build file

* fix test oversight

* added exit 1

* updated docs to specify override

* undo unneeded readme change

* set to undefined rather than empty string

* run git config in correct di

---------

Co-authored-by: Cory Miller <13227161+cory-miller@users.noreply.github.com>
 2023-09-22 13:30:36 -04:00
Varun Sivapalan
72f2cec99f
 		Update README.md for V4 (#1452) 
* Update README.md for V4

* Update actionReference in generate-docs.ts for v4
 2023-09-05 09:21:52 -04:00
Simon Baird
8b5e8b7687
 		Support fetching without the --progress option (#1067) 
Setting the `show-progress` option to false in the `with` section of the
workflow step will cause git fetch to run without `--progress`.

The motivation is to be able to suppress the noisy progress status
output which adds many hundreds of "remote: Counting objects: 85%
(386/453)" and similar lines in the workflow log.

This should be sufficient to resolve #894 and its older friends,
though the solution is different to the one proposed there because
it doesn't use the --quiet flag. IIUC git doesn't show the progress
status by default since the output is not a terminal, so that's why
removing the --progress option is all that's needed.

Adding the --quiet flag doesn't make a lot of difference once the
--progress flag is removed, and actually I think using --quiet would
suppress some other more useful output that would be better left
visible.

Signed-off-by: Simon Baird <sbaird@redhat.com>
 2023-09-01 14:19:18 -04:00
Robert Wieczoreck
7739b9ba2e
 		Add option to fetch tags even if fetch-depth > 0 (#579) 
* Add option to fetch tags even if fetch-depth > 0

* Add jest tests for fetchDepth and fetchTags options
 2023-08-16 16:34:54 -04:00
Johannes Schindelin
d106d4669b
 		Add support for sparse checkouts (#1369) 
* Add support for sparse checkouts

* sparse-checkout: optionally turn off cone mode

While it _is_ true that cone mode is the default nowadays (mainly for
performance reasons: code mode is much faster than non-cone mode), there
_are_ legitimate use cases where non-cone mode is really useful.

Let's add a flag to optionally disable cone mode.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

* Verify minimum Git version for sparse checkout

The `git sparse-checkout` command is available only since Git version
v2.25.0. The `actions/checkout` Action actually supports older Git
versions than that; As of time of writing, the minimum version is
v2.18.0.

Instead of raising this minimum version even for users who do not
require a sparse checkout, only check for this minimum version
specifically when a sparse checkout was asked for.

Suggested-by: Tingluo Huang <tingluohuang@github.com>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

* Support sparse checkout/LFS better

Instead of fetching all the LFS objects present in the current revision
in a sparse checkout, whether they are needed inside the sparse cone or
not, let's instead only pull the ones that are actually needed.

To do that, let's avoid running that preemptive `git lfs fetch` call in
case of a sparse checkout.

An alternative that was considered during the development of this patch
(and ultimately rejected) was to use `git lfs pull --include <path>...`,
but it turned out to be too inflexible because it requires exact paths,
not the patterns that are available via the sparse checkout definition,
and that risks running into command-line length limitations.

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>

---------

Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Co-authored-by: Daniel <daniel.fernandez@feverup.com>
 2023-06-09 09:08:21 -04:00
Ryan van Zeben
3ba5ee6fac
 		Add in explicit reference to private checkout options (#1050) 2022-12-16 16:06:54 -05:00
Scott Brenner
1f9a0c22da
 		README - fix status badge (#967) 2022-10-17 09:49:29 -04:00
Peter Murray
e6d535c99c
 		Inject GitHub host to be able to clone from another GitHub instance (#922) 
* Adding the ability to specify the GitHub Server URL and allowing for it to differ from the Actions workflow host

* Adding tests for injecting the GitHub URL

* Addressing code review comments for PR #922
 2022-09-26 12:34:52 -04:00
Tingluo Huang
0ffe6f9c55
 		Add set-safe-directory input to allow customers to take control. (#770) 
* Add set-safe-directory input to allow customers to take control.
 2022-04-20 21:37:43 -04:00
Thomas Boop
a12a3943b4
 		update readme for v3 (#708) 
* update readme for v3

* update readme with changes

* nit grammar
 2022-03-01 12:46:45 -05:00
Ameya Lokare
230611dbd0
 		Change secret name for PAT to not start with GITHUB_ (#623) 
Github doesn't allow secret names that start with `GITHUB_` (case insensitive). Update README to choose a different prefix (GH).
 2021-11-02 16:20:59 -05:00
eric sciple
592cf69a22
 		Update README.md 2020-07-14 16:30:57 -04:00
eric sciple
a4b69b4886
 		Update README.md 2020-07-14 13:08:52 -04:00
eric sciple
1433f62caa
 		update default branch (#305) 2020-07-14 09:23:30 -04:00
eric sciple
61b9e3751b
 		improve description for fetch-depth (#301) 2020-07-12 21:02:24 -04:00
eric sciple
00a3be8934
 		determine default branch (#278) 2020-06-16 13:41:01 -04:00
eric sciple
e52d022eb5
 		Fetch all history for all tags and branches when fetch-depth=0 (#258) 2020-05-27 09:54:28 -04:00
eric sciple
df86c829eb
 		fix readme (#251) 2020-05-20 10:20:52 -04:00
eric sciple
574281d34c update readme 2020-03-19 22:17:25 -04:00
Jef LeCompte
fbb30c60ab
 		Removed doc based on new changes (#192) 2020-03-19 22:03:41 -04:00
eric sciple
9a3a9ade82
 		persist core.sshCommand for submodules (#184) 
* persist core.sshCommand for submodules

* update verbiage; add comments

* fail when submodules or ssh-key and fallback to REST API
 2020-03-12 11:42:38 -04:00
eric sciple
b2e6b7ed13
 		add ssh support (#163) 2020-03-11 15:55:17 -04:00
eric sciple
422dc45671
 		add support for submodules (#173) 2020-03-05 14:21:59 -05:00
Christopher Sexton
77904fd431
 		Handle submodules with SSH URLs (#140) 
* Handle submodules with SSH URLs

This is just a documentation change, explaining how to fix submodules
that are configured to use SSH URLs instead of HTTPS URLs. Spent a while
banging my head on the wall and hope this saves someone else the pain.

This is helpful for teams that use the SSH protocol for local
development so don't want to change the mechanism that pulls in the
submodules. Using `insteadOf` seems a bit nicer than than setting up a
deploy keypair.

* SSH submodules

Co-authored-by: Chris Patterson <chrispat@github.com>
 2020-02-13 14:44:37 -05:00
eric sciple
bc50a995b8
 		Add link to doc for creating and using encyrpted secrets (#123) 2020-01-03 12:32:17 -05:00
eric sciple
f466b96953
 		improve summary (#127) 2020-01-02 15:40:10 -05:00
eric sciple
c85684db76
 		example fetch all history for all tags and branches (#115) 2019-12-16 10:45:02 -05:00
eric sciple
299dd5064e
 		add more scenarios (#112) 2019-12-13 16:39:47 -05:00
eric sciple
722adc63f1
 		update examples to reference v2 tag (#110) 2019-12-13 00:00:48 -05:00
eric sciple
c170eefc26
 		add input persist-credentials (#107) 2019-12-12 13:49:26 -05:00
eric sciple
a572f640b0
 		fallback to REST API to download repo (#104) 2019-12-12 13:16:16 -05:00
Riddhesh Sanghvi
cab31617d8 Document update: Checkout PR head sha (#102) 2019-12-10 11:17:38 -05:00