actions/checkout
2
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2024-11-23 14:39:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

adr support fetch-refs

Browse Source
This commit is contained in:
eric sciple 2020-02-13 15:53:04 -05:00
parent f858c22e96
commit 8c9b201842
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
adrs/0153-checkout-v2.md
View File

@ -43,12 +43,18 @@ We want to take this opportunity to make behavioral changes, from v1. This docum
fetch-depth: fetch-depth:
description: 'Number of commits to fetch. 0 indicates all history.' description: 'Number of commits to fetch. 0 indicates all history.'
default: 1 default: 1
fetch-refs:
description: >
Additional refs to fetch: `branches`, `tags`, `pr-base`, or `all`.
Combinations are also accepted. For example: `branches, tags`
default: ''
lfs: lfs:
description: 'Whether to download Git-LFS files' description: 'Whether to download Git-LFS files'
default: false default: false
``` ```
Note: Note:
- `fetch-refs` is new
- `persist-credentials` is new - `persist-credentials` is new
- `path` behavior is different (refer [below](#path) for details) - `path` behavior is different (refer [below](#path) for details)
- `submodules` was removed (error if specified; add later if needed) - `submodules` was removed (error if specified; add later if needed)
@ -85,6 +91,8 @@ If a SHA isn't available (e.g. multi repo), then fetch only the specified ref wi
The input `fetch-depth` can be used to control the depth. The input `fetch-depth` can be used to control the depth.
The input `fetch-refs` can be used to fetch additional refs.
Note: Note:
- Fetching a single commit is supported by Git wire protocol version 2. The git client uses protocol version 0 by default. The desired protocol version can be overridden in the git config or on the fetch command line invocation (`-c protocol.version=2`). We will override on the fetch command line, for transparency. - Fetching a single commit is supported by Git wire protocol version 2. The git client uses protocol version 0 by default. The desired protocol version can be overridden in the git config or on the fetch command line invocation (`-c protocol.version=2`). We will override on the fetch command line, for transparency.
- Git client version 2.18+ (released June 2018) is required for wire protocol version 2. - Git client version 2.18+ (released June 2018) is required for wire protocol version 2.